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

Represents a NXOpen::GeometricUtilities::OrientationMethodBuilder. More...

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

Public Types

enum  OrientationOptions {
  OrientationOptionsFixed, OrientationOptionsByFaceNormals, OrientationOptionsByVectorDirection, OrientationOptionsByAnotherCurve,
  OrientationOptionsByAPoint, OrientationOptionsByAngularLaw, OrientationOptionsByForcedDirection
}
 This enum represents the orientation option. More...
 

Public Member Functions

NXOpen::GeometricUtilities::LawBuilderAngularLaw ()
 Returns the angular law. More...
 
NXOpen::ScCollectorFaces ()
 Returns the faces that provide normal direction for alignment of second axis of local coordinate system. More...
 
NXOpen::SelectFaceListNormalFaceList ()
 Returns the normal face list. More...
 
NXOpen::SectionOrientationCurve ()
 Returns the orientation curve. More...
 
NXOpen::GeometricUtilities::OrientationMethodBuilder::OrientationOptions OrientationOption ()
 Returns the orientation option. More...
 
NXOpen::PointOrientationPoint ()
 Returns the orientation point. More...
 
NXOpen::DirectionOrientationVector ()
 Returns the orientation vector. More...
 
void SetOrientationOption (NXOpen::GeometricUtilities::OrientationMethodBuilder::OrientationOptions orientationOption)
 Sets the orientation option. More...
 
void SetOrientationPoint (NXOpen::Point *orientationPoint)
 Sets the orientation point. More...
 
void SetOrientationVector (NXOpen::Direction *orientationVector)
 Sets the orientation vector. 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 NXOpen::GeometricUtilities::OrientationMethodBuilder.


Created in NX5.0.0.

Member Enumeration Documentation

This enum represents the orientation option.

By default, it is set to Fixed. Angular Law orientation option is invalid if 2 guides are selected.

Enumerator
OrientationOptionsFixed 

Fixed.

OrientationOptionsByFaceNormals 

Face Normals.

OrientationOptionsByVectorDirection 

Vector Direction.

OrientationOptionsByAnotherCurve 

Another Curve.

OrientationOptionsByAPoint 

A Point.

OrientationOptionsByAngularLaw 

Angular Law.

OrientationOptionsByForcedDirection 

Forced Direction.

Member Function Documentation

NXOpen::GeometricUtilities::LawBuilder* NXOpen::GeometricUtilities::OrientationMethodBuilder::AngularLaw ( )

Returns the angular law.

For orientation by an Angular Law, the section rotation along the guide curve is governed by the input law.
Created in NX5.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::GeometricUtilities::OrientationMethodBuilder::Faces ( )

Returns the faces that provide normal direction for alignment of second axis of local coordinate system.


Created in NX12.0.0.

License requirements : None

NXOpen::SelectFaceList* NXOpen::GeometricUtilities::OrientationMethodBuilder::NormalFaceList ( )

Returns the normal face list.

For orientation by Face Normals, the second axis of the local coordinate system is aligned with the resultant of normals of the input faces.

Deprecated:
Deprecated in NX12.0.0. Use NXOpen::GeometricUtilities::OrientationMethodBuilder::Faces


Created in NX5.0.0.

License requirements : None

NXOpen::Section* NXOpen::GeometricUtilities::OrientationMethodBuilder::OrientationCurve ( )

Returns the orientation curve.

For orientation by Another Curve, the second axis of the local coordinate system is obtained by joining corresponding points on the guide and the input section.
Created in NX5.0.0.

License requirements : None

NXOpen::GeometricUtilities::OrientationMethodBuilder::OrientationOptions NXOpen::GeometricUtilities::OrientationMethodBuilder::OrientationOption ( )

Returns the orientation option.

Except for Fixed orientation method, additional parameters and/or inputs are required.
Created in NX5.0.0.

License requirements : None

NXOpen::Point* NXOpen::GeometricUtilities::OrientationMethodBuilder::OrientationPoint ( )

Returns the orientation point.

For orientation by a Point, the second axis is obtained with the equivalent of a three-sided ruled sheet between the guide string and the input point.
Created in NX5.0.0.

License requirements : None

NXOpen::Direction* NXOpen::GeometricUtilities::OrientationMethodBuilder::OrientationVector ( )

Returns the orientation vector.

For orientation by Vector, the second axis of the local coordinate system is aligned with the input vector.
Created in NX5.0.0.

License requirements : None

void NXOpen::GeometricUtilities::OrientationMethodBuilder::SetOrientationOption ( NXOpen::GeometricUtilities::OrientationMethodBuilder::OrientationOptions  orientationOption)

Sets the orientation option.

Except for Fixed orientation method, additional parameters and/or inputs are required.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
orientationOptionorientationoption
void NXOpen::GeometricUtilities::OrientationMethodBuilder::SetOrientationPoint ( NXOpen::Point orientationPoint)

Sets the orientation point.

For orientation by a Point, the second axis is obtained with the equivalent of a three-sided ruled sheet between the guide string and the input point.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
orientationPointorientationpoint
void NXOpen::GeometricUtilities::OrientationMethodBuilder::SetOrientationVector ( NXOpen::Direction orientationVector)

Sets the orientation vector.

For orientation by Vector, the second axis of the local coordinate system is aligned with the input vector.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
orientationVectororientationvector
virtual bool NXOpen::GeometricUtilities::OrientationMethodBuilder::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.