NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
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 NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  EndcapMethod { Translation, OffsetExact, OffsetApproximation, None }
 Describes the method that can be applied to the selected geometry to define the End-Cap. More...
 
enum  EndcapSourceOption { Target, Plane, Section, Face }
 Describes the geometry that is used to create the End-Cap face/body. More...
 

Public Member Functions

unsafe
NXOpen.Features.EmbossTarget[] 
GetTargets ()
 The emboss targets More...
 
unsafe void SetDistance (string distance)
 The default distance expression formula string for offset or translation More...
 
unsafe void SetTargets (NXOpen.Features.EmbossTarget[] targets)
 The emboss targets More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe NXOpen.Direction Direction [get, set]
 Returns or sets the direction for translation More...
 
unsafe NXOpen.Expression Distance [get]
 Returns the default distance for offset or translation More...
 
unsafe
NXOpen.Features.EmbossLimit.EndcapMethod 
EndcapOption [get, set]
 Returns or sets the endcap method to create the End-Cap More...
 
unsafe
NXOpen.Features.EmbossLimit.EndcapSourceOption 
EndcapSource [get, set]
 Returns or sets the endcap source option to decide where the End-Cap comes from More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

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.EndcapMethod.OffsetExact

End-Cap Source Option Features.EmbossLimit.EndcapSourceOption.Target

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
Translation 

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

OffsetExact 

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

Default creation.

OffsetApproximation 

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

None 

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
Target 

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

Default creation.

Plane 

Indicates the geometry is datum plane.

Section 

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

Face 

Indicates the geometries are selected surfaces not on the target.

Member Function Documentation

unsafe NXOpen.Features.EmbossTarget [] NXOpen.Features.EmbossLimit.GetTargets ( )
inline

The emboss targets

Created in NX4.0.0

License requirements: None.

Returns
Array of EmbossTarget object. In NX4, only one target is supported.
unsafe void NXOpen.Features.EmbossLimit.SetDistance ( string  distance)
inline

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.
unsafe void NXOpen.Features.EmbossLimit.SetTargets ( NXOpen.Features.EmbossTarget[]  targets)
inline

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.

Property Documentation

unsafe NXOpen.Direction NXOpen.Features.EmbossLimit.Direction
getset

Returns or sets the direction for translation

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.Expression NXOpen.Features.EmbossLimit.Distance
get

Returns the default distance for offset or translation

Created in NX4.0.0

License requirements: None.

unsafe NXOpen.Features.EmbossLimit.EndcapMethod NXOpen.Features.EmbossLimit.EndcapOption
getset

Returns or sets the endcap method to create the End-Cap

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.Features.EmbossLimit.EndcapSourceOption NXOpen.Features.EmbossLimit.EndcapSource
getset

Returns or sets the endcap source option to decide where the End-Cap comes from

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")


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