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

Transformation and orientation tool. More...

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

Public Types

enum  ObjectType {
  ObjectTypeNone, ObjectTypeOrigin, ObjectTypeTranslationX, ObjectTypeTranslationY,
  ObjectTypeTranslationZ, ObjectTypeRotationXY, ObjectTypeRotationYZ, ObjectTypeRotationXZ,
  ObjectTypeScaleX, ObjectTypeScaleY, ObjectTypeScaleZ, ObjectTypeDirectionX,
  ObjectTypeDirectionY, ObjectTypeDirectionZ, ObjectTypePlaneXY, ObjectTypePlaneYZ,
  ObjectTypePlaneXZ, ObjectTypeArcXY, ObjectTypeArcYZ, ObjectTypeArcXZ
}
 Type of objects. More...
 

Public Member Functions

void Activate (NXOpen::GeometricUtilities::TransformerData::ObjectType objectType)
 Sets a component of the tool to be active. More...
 
void AlignToAbsoluteCoordinateSystem ()
 Reorient the tool by aligning it to absolute coordinate system
Created in NX9.0.0. More...
 
void AlignToWorkCoordinateSystem ()
 Reorient the tool by aligning it to work coordinate system
Created in NX9.0.0. More...
 
void ReorientByCoordinateSystem (const NXOpen::Matrix3x3 &matrix)
 Reorient the tool by aligning it to a coordinate system. More...
 
void ReorientByDirection (NXOpen::GeometricUtilities::TransformerData::ObjectType objectType, const NXOpen::Vector3d &direction)
 Reorient the tool by changing its axis direction. More...
 
void Reposition (const NXOpen::Point3d &origin, const NXOpen::Matrix3x3 &matrix)
 Repositions the tool at a coordinate system. More...
 
void RepositionByOrigin (const NXOpen::Point3d &origin)
 Repositions the tool by changing its origin. More...
 
void RepositionByPlane (NXOpen::GeometricUtilities::TransformerData::ObjectType objectType, const NXOpen::Point3d &planeOrigin, const NXOpen::Vector3d &planeNormal)
 Repositions the tool by changing its plane. More...
 
void Reverse (NXOpen::GeometricUtilities::TransformerData::ObjectType axisType)
 Reverses the axis. More...
 
void Rotate (NXOpen::GeometricUtilities::TransformerData::ObjectType axisType, double angle)
 Rotates the tool. More...
 
void Scale (NXOpen::GeometricUtilities::TransformerData::ObjectType axisType, double factor)
 Sets the scale factor. More...
 
void SetTransformationObject (NXOpen::GeometricUtilities::TransformerData::ObjectType objectType)
 Sets a component of the tool using which transformation is started. More...
 
void StartTransformation ()
 Sets current coordinate system as reference coordinate system for the transformation. More...
 
void Translate (NXOpen::GeometricUtilities::TransformerData::ObjectType axisType, double distance)
 Translates the tool. More...
 
void UpdateOnOriginMove ()
 Updates tool upon movement of the point representing origin. 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

Transformation and orientation tool.


Created in NX9.0.0.

Member Enumeration Documentation

Type of objects.

Enumerator
ObjectTypeNone 

none

ObjectTypeOrigin 

origin

ObjectTypeTranslationX 

translation x

ObjectTypeTranslationY 

translation y

ObjectTypeTranslationZ 

translation z

ObjectTypeRotationXY 

rotation xy

ObjectTypeRotationYZ 

rotation yz

ObjectTypeRotationXZ 

rotation xz

ObjectTypeScaleX 

scale x

ObjectTypeScaleY 

scale y

ObjectTypeScaleZ 

scale z

ObjectTypeDirectionX 

direction x

ObjectTypeDirectionY 

direction y

ObjectTypeDirectionZ 

direction z

ObjectTypePlaneXY 

plane xy

ObjectTypePlaneYZ 

plane yz

ObjectTypePlaneXZ 

plane xz

ObjectTypeArcXY 

arc xy

ObjectTypeArcYZ 

arc yz

ObjectTypeArcXZ 

arc xz

Member Function Documentation

void NXOpen::GeometricUtilities::TransformerData::Activate ( NXOpen::GeometricUtilities::TransformerData::ObjectType  objectType)

Sets a component of the tool to be active.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
objectTypeobjecttype
void NXOpen::GeometricUtilities::TransformerData::AlignToAbsoluteCoordinateSystem ( )

Reorient the tool by aligning it to absolute coordinate system
Created in NX9.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::GeometricUtilities::TransformerData::AlignToWorkCoordinateSystem ( )

Reorient the tool by aligning it to work coordinate system
Created in NX9.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::GeometricUtilities::TransformerData::ReorientByCoordinateSystem ( const NXOpen::Matrix3x3 matrix)

Reorient the tool by aligning it to a coordinate system.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
matrixmatrix
void NXOpen::GeometricUtilities::TransformerData::ReorientByDirection ( NXOpen::GeometricUtilities::TransformerData::ObjectType  objectType,
const NXOpen::Vector3d direction 
)

Reorient the tool by changing its axis direction.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
objectTypeobjecttype
directiondirection
void NXOpen::GeometricUtilities::TransformerData::Reposition ( const NXOpen::Point3d origin,
const NXOpen::Matrix3x3 matrix 
)

Repositions the tool at a coordinate system.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
originorigin
matrixmatrix
void NXOpen::GeometricUtilities::TransformerData::RepositionByOrigin ( const NXOpen::Point3d origin)

Repositions the tool by changing its origin.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
originorigin
void NXOpen::GeometricUtilities::TransformerData::RepositionByPlane ( NXOpen::GeometricUtilities::TransformerData::ObjectType  objectType,
const NXOpen::Point3d planeOrigin,
const NXOpen::Vector3d planeNormal 
)

Repositions the tool by changing its plane.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
objectTypeobjecttype
planeOriginplaneorigin
planeNormalplanenormal
void NXOpen::GeometricUtilities::TransformerData::Reverse ( NXOpen::GeometricUtilities::TransformerData::ObjectType  axisType)

Reverses the axis.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
axisTypeaxistype
void NXOpen::GeometricUtilities::TransformerData::Rotate ( NXOpen::GeometricUtilities::TransformerData::ObjectType  axisType,
double  angle 
)

Rotates the tool.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
axisTypeaxistype
angleangle
void NXOpen::GeometricUtilities::TransformerData::Scale ( NXOpen::GeometricUtilities::TransformerData::ObjectType  axisType,
double  factor 
)

Sets the scale factor.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
axisTypeaxistype
factorfactor
void NXOpen::GeometricUtilities::TransformerData::SetTransformationObject ( NXOpen::GeometricUtilities::TransformerData::ObjectType  objectType)

Sets a component of the tool using which transformation is started.

It is possible that user starts transformation without activating a tool component.
Created in NX10.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
objectTypeobjecttype
void NXOpen::GeometricUtilities::TransformerData::StartTransformation ( )

Sets current coordinate system as reference coordinate system for the transformation.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::GeometricUtilities::TransformerData::Translate ( NXOpen::GeometricUtilities::TransformerData::ObjectType  axisType,
double  distance 
)

Translates the tool.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
axisTypeaxistype
distancedistance
void NXOpen::GeometricUtilities::TransformerData::UpdateOnOriginMove ( )

Updates tool upon movement of the point representing origin.


Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

virtual bool NXOpen::GeometricUtilities::TransformerData::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.