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

Represents a spun outline geometry object for turning boundary
Created in NX8.0.0. More...

Inheritance diagram for NXOpen::CAM::SpunOutlineGeom:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  CreationTypes {
  CreationTypesAutomatic, CreationTypesPlanesAtAngles, CreationTypesPlanesThroughPoints, CreationTypesSameAsPart,
  CreationTypesNone
}
 the creation methods More...
 

Public Member Functions

NXOpen::CAM::SpunOutlineGeom::CreationTypes CreationMethod ()
 Returns the creation method
Created in NX8.0.0. More...
 
bool Generate ()
 Generate the spun outline. More...
 
void GetPlanesAtAngles (std::vector< double > &startAngle, std::vector< double > &incrementAngle, std::vector< int > &numberOfPlanes)
 Get the sets of the section planes at angles
Created in NX8.0.0. More...
 
void GetPlanesThroughPoints (std::vector< NXOpen::Point * > &points, std::vector< double > &incrementAngle, std::vector< int > &numberOfPlanes)
 Get the sets of the section planes through points
Created in NX8.0.0. More...
 
void SetCreationMethod (NXOpen::CAM::SpunOutlineGeom::CreationTypes newValue)
 Sets the creation method
Created in NX8.0.0. More...
 
void SetPlanesAtAngles (const std::vector< double > &startAngle, const std::vector< double > &incrementAngle, const std::vector< int > &numberOfPlanes)
 Define the section planes at angles
Created in NX8.0.0. More...
 
void SetPlanesThroughPoints (const std::vector< NXOpen::Point * > &points, const std::vector< double > &incrementAngle, const std::vector< int > &numberOfPlanes)
 Define the section planes through points
Created in NX8.0.0. 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 spun outline geometry object for turning boundary
Created in NX8.0.0.


Member Enumeration Documentation

the creation methods

Enumerator
CreationTypesAutomatic 

spun outline created automatically

CreationTypesPlanesAtAngles 

spun outline created by specifying planes at angles

CreationTypesPlanesThroughPoints 

spun outline created by specifying planes through points

CreationTypesSameAsPart 

spun outline created by the same method as part

CreationTypesNone 

no spun outline

Member Function Documentation

NXOpen::CAM::SpunOutlineGeom::CreationTypes NXOpen::CAM::SpunOutlineGeom::CreationMethod ( )

Returns the creation method
Created in NX8.0.0.



License requirements : None

bool NXOpen::CAM::SpunOutlineGeom::Generate ( )

Generate the spun outline.

Returns
the flag if generated successfully
Created in NX8.0.0.

License requirements : cam_base ("CAM BASE")
void NXOpen::CAM::SpunOutlineGeom::GetPlanesAtAngles ( std::vector< double > &  startAngle,
std::vector< double > &  incrementAngle,
std::vector< int > &  numberOfPlanes 
)

Get the sets of the section planes at angles
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
startAnglearray of start angles for each set
incrementAnglearray of angle increments for each set
numberOfPlanesarray of plane numbers for each set
void NXOpen::CAM::SpunOutlineGeom::GetPlanesThroughPoints ( std::vector< NXOpen::Point * > &  points,
std::vector< double > &  incrementAngle,
std::vector< int > &  numberOfPlanes 
)

Get the sets of the section planes through points
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
pointsarray of start points for each set
incrementAnglearray of angle increments for each set
numberOfPlanesarray of plane numbers for each set
void NXOpen::CAM::SpunOutlineGeom::SetCreationMethod ( NXOpen::CAM::SpunOutlineGeom::CreationTypes  newValue)

Sets the creation method
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
newValuethe creation method
void NXOpen::CAM::SpunOutlineGeom::SetPlanesAtAngles ( const std::vector< double > &  startAngle,
const std::vector< double > &  incrementAngle,
const std::vector< int > &  numberOfPlanes 
)

Define the section planes at angles
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
startAnglearray of start angles for each set
incrementAnglearray of angle increments for each set
numberOfPlanesarray of plane numbers for each set
void NXOpen::CAM::SpunOutlineGeom::SetPlanesThroughPoints ( const std::vector< NXOpen::Point * > &  points,
const std::vector< double > &  incrementAngle,
const std::vector< int > &  numberOfPlanes 
)

Define the section planes through points
Created in NX8.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
pointsarray of start points for each set
incrementAnglearray of angle increments for each set
numberOfPlanesarray of plane numbers for each set
virtual bool NXOpen::CAM::SpunOutlineGeom::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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