nxopen.features

Interface EmbossTarget

All Superinterfaces:

Remote, TaggedObject

public interface EmbossTarget
extends TaggedObject

Represents a target object.
This class provides methods to set and get the target faces, the End-Cap source entity and offset/translation distance value.

Following are default values and options:

Target Faces User must set it

End-Cap Faces User must set it when End-Cap source option is face.

End-Cap Plane User must set it when End-Cap source option is plane.

End-Cap Translate Direction Flip false

Target Offset/Translate Distance 2.0/5.0[in/mm]

Created in NX4.0.0

Method Summary

Modifier and Type	Method and Description
Expression	distance() Returns the offset/translate distance License requirements: None.
ScCollector	endcapFace() Returns the face to produce End-Cap License requirements: None.
ISurface	endcapPlane() Returns the plane to produce End-Cap License requirements: None.
boolean	flipDirection() Returns the flip flag for translation direction License requirements: None.
void	setDistance(String distance) The distance expression formula string for offset or translation License requirements: solid_modeling ("SOLIDS MODELING") .
void	setEndcapFace(ScCollector endcapFaceCollector) Sets the face to produce End-Cap License requirements: solid_modeling ("SOLIDS MODELING") .
void	setEndcapPlane(ISurface endcapPlane) Sets the plane to produce End-Cap License requirements: solid_modeling ("SOLIDS MODELING") .
void	setFlipDirection(boolean dirFlip) Sets the flip flag for translation direction License requirements: solid_modeling ("SOLIDS MODELING") .
void	setTargetFace(ScCollector targetFaceCollector) Sets the target faces on which the emboss places.
ScCollector	targetFace() Returns the target faces on which the emboss places.

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Method Detail

setTargetFace

void setTargetFace(ScCollector targetFaceCollector)
            throws NXException,
                   RemoteException

Sets the target faces on which the emboss places.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX4.0.0

Parameters:

targetFaceCollector - Target faces on which the emboss places.

Throws:

NXException

RemoteException

targetFace

ScCollector targetFace()
                throws NXException,
                       RemoteException

Returns the target faces on which the emboss places.
License requirements: None.

Created in NX4.0.0

Returns:

Target faces on which the emboss places.

Throws:

NXException

RemoteException

setEndcapFace

void setEndcapFace(ScCollector endcapFaceCollector)
            throws NXException,
                   RemoteException

Sets the face to produce End-Cap
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX4.0.0

Parameters:

endcapFaceCollector - Faces to create endcap if End-Cap source option is Features.EmbossLimit.EndcapSourceOption#FACE

Throws:

NXException

RemoteException

endcapFace

ScCollector endcapFace()
                throws NXException,
                       RemoteException

Returns the face to produce End-Cap
License requirements: None.

Created in NX4.0.0

Returns:

Faces to create End-Cap if End-Cap source option is Features.EmbossLimit.EndcapSourceOption#FACE

Throws:

NXException

RemoteException

setEndcapPlane

void setEndcapPlane(ISurface endcapPlane)
             throws NXException,
                    RemoteException

Sets the plane to produce End-Cap
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX4.0.0

Parameters:

endcapPlane - Plane to create End-Cap if End-Cap source option is Features.EmbossLimit.EndcapSourceOption#PLANE

Throws:

NXException

RemoteException

endcapPlane

ISurface endcapPlane()
              throws NXException,
                     RemoteException

Returns the plane to produce End-Cap
License requirements: None.

Created in NX4.0.0

Returns:

Plane to create End-Cap if End-Cap source option is Features.EmbossLimit.EndcapSourceOption#PLANE

Throws:

NXException

RemoteException

setDistance

void setDistance(String distance)
          throws NXException,
                 RemoteException

The distance expression formula string for offset or translation
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX4.0.0

Parameters:

distance - The distance expression formula string for offset or translation
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

distance

Expression distance()
             throws NXException,
                    RemoteException

Returns the offset/translate distance
License requirements: None.

Created in NX4.0.0

Returns:

The distance for offset or translation

Throws:

NXException

RemoteException

setFlipDirection

void setFlipDirection(boolean dirFlip)
               throws NXException,
                      RemoteException

Sets the flip flag for translation direction
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX4.0.0

Parameters:

dirFlip - If true, the emboss direction is reversed to the defined translation direction

Throws:

NXException

RemoteException

flipDirection

boolean flipDirection()
               throws NXException,
                      RemoteException

Returns the flip flag for translation direction
License requirements: None.

Created in NX4.0.0

Returns:

If true, the emboss direction is reversed to the defined translation direction

Throws:

NXException

RemoteException