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

Represents a Surface Regions Builder
To create a new instance of this class, use NXOpen::CAM::CAMSetup::CreateSurfaceRegions

Created in NX8.0.0. More...

Inheritance diagram for NXOpen::CAM::SurfaceRegions:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  CreateRegionsTypes { CreateRegionsTypesSteep, CreateRegionsTypesNonSteep, CreateRegionsTypesSteepAndNonSteep }
 enum for create regions More...
 
enum  FeatureTypes { FeatureTypesFace, FeatureTypesRegionOfFaces, FeatureTypesBody, FeatureTypesSteep }
 enum for feature type More...
 

Public Member Functions

double AngleTolerance ()
 Returns the angle tolerance
Created in NX8.0.0. More...
 
bool AtTimestamp ()
 Returns the at timestamp flag
Created in NX8.0.0. More...
 
NXOpen::SelectBodyListBodies ()
 Returns the bodies
Created in NX8.0.0. More...
 
NXOpen::SelectFaceListBoundaryFaces ()
 Returns the boundary faces
Created in NX8.0.0. More...
 
NXOpen::CAM::SurfaceRegions::CreateRegionsTypes CreateRegionsOption ()
 Returns the create regions type
Created in NX8.0.0. More...
 
NXOpen::DirectionCutDirection ()
 Returns the cut direction
Created in NX8.0.0. More...
 
NXOpen::DirectionDirection ()
 Returns the direction
Created in NX8.0.0. More...
 
NXOpen::SelectFaceListExcludedFaces ()
 Returns the excluded faces
Created in NX8.0.0. More...
 
NXOpen::SelectFaceListFaces ()
 Returns the faces
Created in NX8.0.0. More...
 
NXOpen::CAM::SurfaceRegions::FeatureTypes FeatureType ()
 Returns the feature type
Created in NX8.0.0. More...
 
double IsoclineAngle ()
 Returns the isocline angle
Created in NX8.0.0. More...
 
bool LimitSteepByCutDirection ()
 Returns the limit steep by cut direction flag
Created in NX8.0.0. More...
 
NXOpen::FaceSeedFace ()
 Returns the seed face
Created in NX8.0.0. More...
 
void SetAngleTolerance (double angleTol)
 Sets the angle tolerance
Created in NX8.0.0. More...
 
void SetAtTimestamp (bool timestamp)
 Sets the at timestamp flag
Created in NX8.0.0. More...
 
void SetCreateRegionsOption (NXOpen::CAM::SurfaceRegions::CreateRegionsTypes type)
 Sets the create regions type
Created in NX8.0.0. More...
 
void SetCutDirection (NXOpen::Direction *direction)
 Sets the cut direction
Created in NX8.0.0. More...
 
void SetDirection (NXOpen::Direction *direction)
 Sets the direction
Created in NX8.0.0. More...
 
void SetFeatureType (NXOpen::CAM::SurfaceRegions::FeatureTypes type)
 Sets the feature type
Created in NX8.0.0. More...
 
void SetIsoclineAngle (double angle)
 Sets the isocline angle
Created in NX8.0.0. More...
 
void SetLimitSteepByCutDirection (bool limit)
 Sets the limit steep by cut direction flag
Created in NX8.0.0. More...
 
void SetSeedFace (NXOpen::Face *face)
 Sets the seed face
Created in NX8.0.0. More...
 
void SetSteepBody (NXOpen::Body *body)
 Sets the steep body
Created in NX8.0.0. More...
 
void SetSurfaceRegionName (const NXString &name)
 Sets the surface region name
Created in NX8.0.0. More...
 
void SetSurfaceRegionName (const char *name)
 Sets the surface region name
Created in NX8.0.0. More...
 
void SetTraverseInteriorEdges (bool traverseInteriorEdges)
 Sets the traverse interior edges flag
Created in NX8.0.0. More...
 
void SetUseTangentEdgeAngles (bool useAngle)
 Sets the use tangent edge angle flag
Created in NX8.0.0. More...
 
NXOpen::BodySteepBody ()
 Returns the steep body
Created in NX8.0.0. More...
 
NXString SurfaceRegionName ()
 Returns the surface region name
Created in NX8.0.0. More...
 
bool TraverseInteriorEdges ()
 Returns the traverse interior edges flag
Created in NX8.0.0. More...
 
bool UseTangentEdgeAngles ()
 Returns the use tangent edge angle flag
Created in NX8.0.0. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a Surface Regions Builder
To create a new instance of this class, use NXOpen::CAM::CAMSetup::CreateSurfaceRegions

Created in NX8.0.0.


Member Enumeration Documentation

enum for create regions

Enumerator
CreateRegionsTypesSteep 

steep

CreateRegionsTypesNonSteep 

non-steep

CreateRegionsTypesSteepAndNonSteep 

steep and non-steep

enum for feature type

Enumerator
FeatureTypesFace 

type to face

FeatureTypesRegionOfFaces 

type to region

FeatureTypesBody 

type to body

FeatureTypesSteep 

type to steep

Member Function Documentation

double NXOpen::CAM::SurfaceRegions::AngleTolerance ( )

Returns the angle tolerance
Created in NX8.0.0.



License requirements : None

bool NXOpen::CAM::SurfaceRegions::AtTimestamp ( )

Returns the at timestamp flag
Created in NX8.0.0.



License requirements : None

NXOpen::SelectBodyList* NXOpen::CAM::SurfaceRegions::Bodies ( )

Returns the bodies
Created in NX8.0.0.



License requirements : None

NXOpen::SelectFaceList* NXOpen::CAM::SurfaceRegions::BoundaryFaces ( )

Returns the boundary faces
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::SurfaceRegions::CreateRegionsTypes NXOpen::CAM::SurfaceRegions::CreateRegionsOption ( )

Returns the create regions type
Created in NX8.0.0.



License requirements : None

NXOpen::Direction* NXOpen::CAM::SurfaceRegions::CutDirection ( )

Returns the cut direction
Created in NX8.0.0.



License requirements : None

NXOpen::Direction* NXOpen::CAM::SurfaceRegions::Direction ( )

Returns the direction
Created in NX8.0.0.



License requirements : None

NXOpen::SelectFaceList* NXOpen::CAM::SurfaceRegions::ExcludedFaces ( )

Returns the excluded faces
Created in NX8.0.0.



License requirements : None

NXOpen::SelectFaceList* NXOpen::CAM::SurfaceRegions::Faces ( )

Returns the faces
Created in NX8.0.0.



License requirements : None

NXOpen::CAM::SurfaceRegions::FeatureTypes NXOpen::CAM::SurfaceRegions::FeatureType ( )

Returns the feature type
Created in NX8.0.0.



License requirements : None

double NXOpen::CAM::SurfaceRegions::IsoclineAngle ( )

Returns the isocline angle
Created in NX8.0.0.



License requirements : None

bool NXOpen::CAM::SurfaceRegions::LimitSteepByCutDirection ( )

Returns the limit steep by cut direction flag
Created in NX8.0.0.



License requirements : None

NXOpen::Face* NXOpen::CAM::SurfaceRegions::SeedFace ( )

Returns the seed face
Created in NX8.0.0.



License requirements : None

void NXOpen::CAM::SurfaceRegions::SetAngleTolerance ( double  angleTol)

Sets the angle tolerance
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
angleTolangletol
void NXOpen::CAM::SurfaceRegions::SetAtTimestamp ( bool  timestamp)

Sets the at timestamp flag
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
timestamptimestamp
void NXOpen::CAM::SurfaceRegions::SetCreateRegionsOption ( NXOpen::CAM::SurfaceRegions::CreateRegionsTypes  type)

Sets the create regions type
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
typetype
void NXOpen::CAM::SurfaceRegions::SetCutDirection ( NXOpen::Direction direction)

Sets the cut direction
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
directiondirection
void NXOpen::CAM::SurfaceRegions::SetDirection ( NXOpen::Direction direction)

Sets the direction
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
directiondirection
void NXOpen::CAM::SurfaceRegions::SetFeatureType ( NXOpen::CAM::SurfaceRegions::FeatureTypes  type)

Sets the feature type
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
typetype
void NXOpen::CAM::SurfaceRegions::SetIsoclineAngle ( double  angle)

Sets the isocline angle
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
angleangle
void NXOpen::CAM::SurfaceRegions::SetLimitSteepByCutDirection ( bool  limit)

Sets the limit steep by cut direction flag
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
limitlimit
void NXOpen::CAM::SurfaceRegions::SetSeedFace ( NXOpen::Face face)

Sets the seed face
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
faceface
void NXOpen::CAM::SurfaceRegions::SetSteepBody ( NXOpen::Body body)

Sets the steep body
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
bodybody
void NXOpen::CAM::SurfaceRegions::SetSurfaceRegionName ( const NXString name)

Sets the surface region name
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
namename
void NXOpen::CAM::SurfaceRegions::SetSurfaceRegionName ( const char *  name)

Sets the surface region name
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
namename
void NXOpen::CAM::SurfaceRegions::SetTraverseInteriorEdges ( bool  traverseInteriorEdges)

Sets the traverse interior edges flag
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
traverseInteriorEdgestraverseinterioredges
void NXOpen::CAM::SurfaceRegions::SetUseTangentEdgeAngles ( bool  useAngle)

Sets the use tangent edge angle flag
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
useAngleuseangle
NXOpen::Body* NXOpen::CAM::SurfaceRegions::SteepBody ( )

Returns the steep body
Created in NX8.0.0.



License requirements : None

NXString NXOpen::CAM::SurfaceRegions::SurfaceRegionName ( )

Returns the surface region name
Created in NX8.0.0.



License requirements : None

bool NXOpen::CAM::SurfaceRegions::TraverseInteriorEdges ( )

Returns the traverse interior edges flag
Created in NX8.0.0.



License requirements : None

bool NXOpen::CAM::SurfaceRegions::UseTangentEdgeAngles ( )

Returns the use tangent edge angle flag
Created in NX8.0.0.



License requirements : None


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