NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::EmbossLimit Class Reference

Represents emboss start and end objects, meaning, targets and end-cap definitions. More...

Inheritance diagram for NXOpen::Features::EmbossLimit:
NXOpen::TaggedObject

List of all members.

Public Types

enum  EndcapMethod { EndcapMethodTranslation, EndcapMethodOffsetExact, EndcapMethodOffsetApproximation, EndcapMethodNone }
 Describes the method that can be applied to the selected geometry to define the End-Cap. More...
enum  EndcapSourceOption { EndcapSourceOptionTarget, EndcapSourceOptionPlane, EndcapSourceOptionSection, EndcapSourceOptionFace }
 Describes the geometry that is used to create the End-Cap face/body. More...

Public Member Functions

NXOpen::DirectionDirection ()
 Returns the direction for translation
Created in NX4.0.0.
NXOpen::ExpressionDistance ()
 Returns the default distance for offset or translation
Created in NX4.0.0.
NXOpen::Features::EmbossLimit::EndcapMethod EndcapOption ()
 Returns the endcap method to create the End-Cap
Created in NX4.0.0.
NXOpen::Features::EmbossLimit::EndcapSourceOption EndcapSource ()
 Returns the endcap source option to decide where the End-Cap comes from
Created in NX4.0.0.
std::vector
< NXOpen::Features::EmbossTarget * > 
GetTargets ()
 The emboss targets.
void SetDirection (NXOpen::Direction *direction)
 Sets the direction for translation
Created in NX4.0.0.
void SetDistance (const NXString &distance)
 The default distance expression formula string for offset or translation
Created in NX4.0.0.
void SetEndcapOption (NXOpen::Features::EmbossLimit::EndcapMethod endcapOption)
 Sets the endcap method to create the End-Cap
Created in NX4.0.0.
void SetEndcapSource (NXOpen::Features::EmbossLimit::EndcapSourceOption endcapSourceOption)
 Sets the endcap source option to decide where the End-Cap comes from
Created in NX4.0.0.
void SetTargets (const std::vector< NXOpen::Features::EmbossTarget * > &targets)
 The emboss targets
Created in NX4.0.0.

Detailed Description

Represents emboss start and end objects, meaning, targets and end-cap definitions.


This class provides methods to set and get the various emboss limit sub components.

Following are default values and options:


End-Cap Option Features::EmbossLimit::EndcapMethodOffsetExact

End-Cap Source Option Features::EmbossLimit::EndcapSourceOptionTarget

Emboss Target (array) EmbossTarget object

End-Cap Direction Translate direction

Distance (translate or offset) 2.0/5.0[in/mm]


Created in NX4.0.0.


Member Enumeration Documentation

Describes the method that can be applied to the selected geometry to define the End-Cap.

Enumerator:
EndcapMethodTranslation 

Indicates End-Cap geometry is a translation along a user controlled vector.

EndcapMethodOffsetExact 

Indicates End-Cap geometry is formulated as an exact offset of the selected End-Cap geometry.

Default creation.

EndcapMethodOffsetApproximation 

Indicates End-Cap geometry is formulated as an approximate offset of the selected End-Cap geometry.

EndcapMethodNone 

Indicates End-Cap geometry is formulated by the selected geometry without displacement.

Describes the geometry that is used to create the End-Cap face/body.

Enumerator:
EndcapSourceOptionTarget 

Indicates the geometries are some of the faces on the Target Body.

Default creation.

EndcapSourceOptionPlane 

Indicates the geometry is datum plane.

EndcapSourceOptionSection 

Indicates the geometry is the sketch plane on which the section resides.

EndcapSourceOptionFace 

Indicates the geometries are selected surfaces not on the target.


Member Function Documentation

Returns the direction for translation
Created in NX4.0.0.



License requirements : None

Returns the default distance for offset or translation
Created in NX4.0.0.



License requirements : None

Returns the endcap method to create the End-Cap
Created in NX4.0.0.



License requirements : None

Returns the endcap source option to decide where the End-Cap comes from
Created in NX4.0.0.



License requirements : None

The emboss targets.

Returns:
Array of EmbossTarget object. In NX4, only one target is supported.
Created in NX4.0.0.

License requirements : None

Sets the direction for translation
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
directionThe direction for translation.

The default distance expression formula string for offset or translation
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
distanceThe default distance expression formula string for offset or translation.

Sets the endcap method to create the End-Cap
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
endcapOptionThe End-Cap method to create the End-Cap.

Sets the endcap source option to decide where the End-Cap comes from
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
endcapSourceOptionThe End-Cap source option to decide where the End-Cap comes from.

The emboss targets
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
targetsArray of EmbossTarget object. In NX4, only one target is supported.

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.