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

This class manages the control poles movements for a surface or curve. More...

Inheritance diagram for NXOpen::GeometricUtilities::MovePoleBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  MoveMethodType {
  MoveMethodTypeWcs, MoveMethodTypeView, MoveMethodTypeVector, MoveMethodTypePlane,
  MoveMethodTypeNormal, MoveMethodTypePolygon
}
 Move Pole types. More...
 
enum  WCSDirectionType {
  WCSDirectionTypeX, WCSDirectionTypeY, WCSDirectionTypeZ, WCSDirectionTypeYZ,
  WCSDirectionTypeXZ, WCSDirectionTypeXY
}
 WCS direction. More...
 

Public Member Functions

NXOpen::GeometricUtilities::ControlPoleManagerDataControlPoleManager ()
 Returns the control pole manager
Created in NX8.5.0. More...
 
NXOpen::GeometricUtilities::DegreesAndSegmentsOrPatchesBuilderDegreesAndPatches ()
 Returns the degrees and patches
Created in NX8.5.0. More...
 
NXOpen::NXObjectEntity ()
 Returns the entity
Created in NX8.5.0. More...
 
NXOpen::GeometricUtilities::MovePoleBuilder::MoveMethodType MoveMethod ()
 Returns the control pole move method
Created in NX8.5.0. More...
 
NXOpen::PlanePlane ()
 Returns the plane
Created in NX8.5.0. More...
 
void SetEntity (NXOpen::NXObject *entity)
 Sets the entity
Created in NX8.5.0. More...
 
void SetMoveMethod (NXOpen::GeometricUtilities::MovePoleBuilder::MoveMethodType moveMethod)
 Sets the control pole move method
Created in NX8.5.0. More...
 
void SetPlane (NXOpen::Plane *plane)
 Sets the plane
Created in NX8.5.0. More...
 
void SetVector (NXOpen::Direction *vector)
 Sets the vector
Created in NX8.5.0. More...
 
void SetWCSDirection (NXOpen::GeometricUtilities::MovePoleBuilder::WCSDirectionType wcsDirection)
 Sets the fixed direction
Created in NX8.5.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
NXOpen::DirectionVector ()
 Returns the vector
Created in NX8.5.0. More...
 
NXOpen::GeometricUtilities::MovePoleBuilder::WCSDirectionType WCSDirection ()
 Returns the fixed direction
Created in NX8.5.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

This class manages the control poles movements for a surface or curve.


Created in NX8.5.0.

Member Enumeration Documentation

Move Pole types.

Enumerator
MoveMethodTypeWcs 

wcs

MoveMethodTypeView 

view

MoveMethodTypeVector 

vector

MoveMethodTypePlane 

plane

MoveMethodTypeNormal 

normal

MoveMethodTypePolygon 

polygon

WCS direction.

Enumerator
WCSDirectionTypeX 

x

WCSDirectionTypeY 

y

WCSDirectionTypeZ 

z

WCSDirectionTypeYZ 

yz

WCSDirectionTypeXZ 

xz

WCSDirectionTypeXY 

xy

Member Function Documentation

NXOpen::GeometricUtilities::ControlPoleManagerData* NXOpen::GeometricUtilities::MovePoleBuilder::ControlPoleManager ( )

Returns the control pole manager
Created in NX8.5.0.



License requirements : None

NXOpen::GeometricUtilities::DegreesAndSegmentsOrPatchesBuilder* NXOpen::GeometricUtilities::MovePoleBuilder::DegreesAndPatches ( )

Returns the degrees and patches
Created in NX8.5.0.



License requirements : None

NXOpen::NXObject* NXOpen::GeometricUtilities::MovePoleBuilder::Entity ( )

Returns the entity
Created in NX8.5.0.



License requirements : None

NXOpen::GeometricUtilities::MovePoleBuilder::MoveMethodType NXOpen::GeometricUtilities::MovePoleBuilder::MoveMethod ( )

Returns the control pole move method
Created in NX8.5.0.



License requirements : None

NXOpen::Plane* NXOpen::GeometricUtilities::MovePoleBuilder::Plane ( )

Returns the plane
Created in NX8.5.0.



License requirements : None

void NXOpen::GeometricUtilities::MovePoleBuilder::SetEntity ( NXOpen::NXObject entity)

Sets the entity
Created in NX8.5.0.



License requirements : None

Parameters
entityentity
void NXOpen::GeometricUtilities::MovePoleBuilder::SetMoveMethod ( NXOpen::GeometricUtilities::MovePoleBuilder::MoveMethodType  moveMethod)

Sets the control pole move method
Created in NX8.5.0.



License requirements : None

Parameters
moveMethodmovemethod
void NXOpen::GeometricUtilities::MovePoleBuilder::SetPlane ( NXOpen::Plane plane)

Sets the plane
Created in NX8.5.0.



License requirements : None

Parameters
planeplane
void NXOpen::GeometricUtilities::MovePoleBuilder::SetVector ( NXOpen::Direction vector)

Sets the vector
Created in NX8.5.0.



License requirements : None

Parameters
vectorvector
void NXOpen::GeometricUtilities::MovePoleBuilder::SetWCSDirection ( NXOpen::GeometricUtilities::MovePoleBuilder::WCSDirectionType  wcsDirection)

Sets the fixed direction
Created in NX8.5.0.



License requirements : None

Parameters
wcsDirectionwcsdirection
virtual bool NXOpen::GeometricUtilities::MovePoleBuilder::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.

NXOpen::Direction* NXOpen::GeometricUtilities::MovePoleBuilder::Vector ( )

Returns the vector
Created in NX8.5.0.



License requirements : None

NXOpen::GeometricUtilities::MovePoleBuilder::WCSDirectionType NXOpen::GeometricUtilities::MovePoleBuilder::WCSDirection ( )

Returns the fixed direction
Created in NX8.5.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.