NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAM::BoundarySet Class Reference

Represents a boundary set. More...

Inheritance diagram for NXOpen::CAM::BoundarySet:
NXOpen::TaggedObject NXOpen::CAM::BoundaryMillingSet NXOpen::CAM::BoundarySetPlanarMill NXOpen::CAM::BoundaryTurnSet

Public Types

enum  BoundaryTypes { BoundaryTypesClosed, BoundaryTypesOpen }
 the boundary types
Created in NX9.0.0. More...
 
enum  PlaneTypes { PlaneTypesAutomatic, PlaneTypesUserDefined }
 the boundary plane types
Created in NX9.0.0. More...
 
enum  ToolPositionTypes { ToolPositionTypesOn, ToolPositionTypesContact }
 the tool position
Created in NX9.0.1. More...
 
enum  ToolSideTypes { ToolSideTypesInsideOrLeft, ToolSideTypesOutsideOrRight }
 the tool side types
Created in NX9.0.0. More...
 

Public Member Functions

void AppendCurves (const std::vector< NXOpen::NXObject * > &curves, const NXOpen::Point3d &pickPoint, const NXOpen::Matrix3x3 &matrix)
 Add curves to the boundary
Created in NX9.0.0. More...
 
NXOpen::CAM::BoundaryMemberSetListBoundaryMemberList ()
 Returns the boundary member list
Created in NX9.0.0. More...
 
NXOpen::CAM::BoundarySet::BoundaryTypes BoundaryType ()
 Returns the boundary type
Created in NX9.0.0. More...
 
NXOpen::CAM::BoundaryMemberSetCreateBoundaryMemberSet ()
 Create an empty boundary member set. More...
 
bool CustomOffset ()
 Returns the flag whether this boundary has custom offset activated
Created in NX9.0.0. More...
 
double Offset ()
 Returns the offset value
Created in NX9.0.0. More...
 
NXOpen::CAM::ParamValueIntent OffsetIntent ()
 Returns the offset intent
Created in NX9.0.0. More...
 
NXOpen::PlanePlane ()
 Returns the boundary plane
Created in NX9.0.0. More...
 
NXOpen::CAM::BoundarySet::PlaneTypes PlaneType ()
 Returns the boundary plane type
Created in NX9.0.0. More...
 
NXOpen::SelectTaggedObjectListPointList ()
 Returns the points list
Created in NX9.0.0. More...
 
void RemoveCurves (const std::vector< NXOpen::NXObject * > &curves)
 Remove curves from the boundary
Created in NX9.0.0. More...
 
NXOpen::SelectTaggedObjectSelectObject ()
 Returns the select object
Created in NX11.0.1. More...
 
void SetBoundaryType (NXOpen::CAM::BoundarySet::BoundaryTypes newValue)
 Sets the boundary type
Created in NX9.0.0. More...
 
void SetCustomOffset (bool newValue)
 Sets the flag whether this boundary has custom offset activated
Created in NX9.0.0. More...
 
void SetOffset (double newValue)
 Sets the offset value
Created in NX9.0.0. More...
 
void SetOffsetIntent (NXOpen::CAM::ParamValueIntent newValue)
 Sets the offset intent
Created in NX9.0.0. More...
 
void SetPlane (NXOpen::Plane *newValue)
 Sets the boundary plane
Created in NX9.0.0. More...
 
void SetPlaneType (NXOpen::CAM::BoundarySet::PlaneTypes newValue)
 Sets the boundary plane type
Created in NX9.0.0. More...
 
void SetToolPosition (NXOpen::CAM::BoundarySet::ToolPositionTypes newValue)
 Sets the tool position
Created in NX9.0.1. More...
 
void SetToolSide (NXOpen::CAM::BoundarySet::ToolSideTypes newValue)
 Sets the tool side
Created in NX9.0.0. More...
 
NXOpen::CAM::BoundarySet::ToolPositionTypes ToolPosition ()
 Returns the tool position
Created in NX9.0.1. More...
 
NXOpen::CAM::BoundarySet::ToolSideTypes ToolSide ()
 Returns the tool side
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a boundary set.


To create a new instance of this class, use NXOpen::CAM::Boundary::CreateBoundarySet

Created in NX9.0.0.

Member Enumeration Documentation

the boundary types
Created in NX9.0.0.


Enumerator
BoundaryTypesClosed 

close boundary

BoundaryTypesOpen 

open boundary

the boundary plane types
Created in NX9.0.0.


Enumerator
PlaneTypesAutomatic 

automatically get a boundary plane from selected entities

PlaneTypesUserDefined 

user defined plane

the tool position
Created in NX9.0.1.


Enumerator
ToolPositionTypesOn 

tool tip positioned on boundary

ToolPositionTypesContact 

tool tip positioned contacting boundary

the tool side types
Created in NX9.0.0.


Enumerator
ToolSideTypesInsideOrLeft 

inside for closed boundary, or left side for open boundary

ToolSideTypesOutsideOrRight 

outside for closed boundary, or right side for open boundary

Member Function Documentation

void NXOpen::CAM::BoundarySet::AppendCurves ( const std::vector< NXOpen::NXObject * > &  curves,
const NXOpen::Point3d pickPoint,
const NXOpen::Matrix3x3 matrix 
)

Add curves to the boundary
Created in NX9.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
curvesthe curves
pickPointthe pick point (start point on first member)
matrixthe view matrix
NXOpen::CAM::BoundaryMemberSetList* NXOpen::CAM::BoundarySet::BoundaryMemberList ( )

Returns the boundary member list
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::BoundarySet::BoundaryTypes NXOpen::CAM::BoundarySet::BoundaryType ( )

Returns the boundary type
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::BoundaryMemberSet* NXOpen::CAM::BoundarySet::CreateBoundaryMemberSet ( )

Create an empty boundary member set.

Returns

Created in NX9.0.0.

License requirements : cam_base ("CAM BASE")
bool NXOpen::CAM::BoundarySet::CustomOffset ( )

Returns the flag whether this boundary has custom offset activated
Created in NX9.0.0.



License requirements : None

double NXOpen::CAM::BoundarySet::Offset ( )

Returns the offset value
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::ParamValueIntent NXOpen::CAM::BoundarySet::OffsetIntent ( )

Returns the offset intent
Created in NX9.0.0.



License requirements : None

NXOpen::Plane* NXOpen::CAM::BoundarySet::Plane ( )

Returns the boundary plane
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::BoundarySet::PlaneTypes NXOpen::CAM::BoundarySet::PlaneType ( )

Returns the boundary plane type
Created in NX9.0.0.



License requirements : None

NXOpen::SelectTaggedObjectList* NXOpen::CAM::BoundarySet::PointList ( )

Returns the points list
Created in NX9.0.0.



License requirements : None

void NXOpen::CAM::BoundarySet::RemoveCurves ( const std::vector< NXOpen::NXObject * > &  curves)

Remove curves from the boundary
Created in NX9.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
curvesthe curves
NXOpen::SelectTaggedObject* NXOpen::CAM::BoundarySet::SelectObject ( )

Returns the select object
Created in NX11.0.1.



License requirements : None

void NXOpen::CAM::BoundarySet::SetBoundaryType ( NXOpen::CAM::BoundarySet::BoundaryTypes  newValue)

Sets the boundary type
Created in NX9.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySet::SetCustomOffset ( bool  newValue)

Sets the flag whether this boundary has custom offset activated
Created in NX9.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySet::SetOffset ( double  newValue)

Sets the offset value
Created in NX9.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySet::SetOffsetIntent ( NXOpen::CAM::ParamValueIntent  newValue)

Sets the offset intent
Created in NX9.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySet::SetPlane ( NXOpen::Plane newValue)

Sets the boundary plane
Created in NX9.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySet::SetPlaneType ( NXOpen::CAM::BoundarySet::PlaneTypes  newValue)

Sets the boundary plane type
Created in NX9.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySet::SetToolPosition ( NXOpen::CAM::BoundarySet::ToolPositionTypes  newValue)

Sets the tool position
Created in NX9.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
void NXOpen::CAM::BoundarySet::SetToolSide ( NXOpen::CAM::BoundarySet::ToolSideTypes  newValue)

Sets the tool side
Created in NX9.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuenewvalue
NXOpen::CAM::BoundarySet::ToolPositionTypes NXOpen::CAM::BoundarySet::ToolPosition ( )

Returns the tool position
Created in NX9.0.1.



License requirements : None

NXOpen::CAM::BoundarySet::ToolSideTypes NXOpen::CAM::BoundarySet::ToolSide ( )

Returns the tool side
Created in NX9.0.0.



License requirements : None


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