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

Represents a NXOpen::Die::DieDirectionBuilder . More...

Inheritance diagram for NXOpen::Die::DieDirectionBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DirectionType { DirectionTypeSelection, DirectionTypeCoordinateSystem, DirectionTypeVector }
 the options available for defining the direction More...
 

Public Member Functions

NXOpen::Matrix3x3 CoordinateSystemMatrix ()
 Returns the coordinate system matrix
Created in NX6.0.0. More...
 
NXOpen::Point3d CoordinateSystemOrigin ()
 Returns the coordinate system origin
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectDirection ()
 Returns the selected direction
Created in NX6.0.0. More...
 
NXOpen::Die::DieDirectionBuilder::DirectionType InputType ()
 Returns the type of input that defined the direction
Created in NX7.5.0. More...
 
bool ReverseSourceDirection ()
 Returns the indication if the source's direction should be reversed. More...
 
void SetCoordinateSystemMatrix (const NXOpen::Matrix3x3 &coordinateSystemMatrix)
 Sets the coordinate system matrix
Created in NX6.0.0. More...
 
void SetCoordinateSystemOrigin (const NXOpen::Point3d &coordinateSystemOrigin)
 Sets the coordinate system origin
Created in NX6.0.0. More...
 
void SetInputType (NXOpen::Die::DieDirectionBuilder::DirectionType inputType)
 Sets the type of input that defined the direction
Created in NX7.5.0. More...
 
void SetReverseSourceDirection (bool reverseSourceDirection)
 Sets the indication if the source's direction should be reversed. More...
 
void SetVector (NXOpen::Direction *vector)
 Sets the specified vector
Created in NX6.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
NXOpen::DirectionVector ()
 Returns the specified vector
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::Die::DieDirectionBuilder .

The Die Direction is a helper to the main Die Design feature to gather the vector for items such as Trim direction or Flange direction. Note that if a coordinate system is specified, then the direction will be -Z of that coordinate system.
To create a new instance of this class, use NXOpen::Die::DieCollection::CreateDieDirection

Created in NX6.0.0.

Member Enumeration Documentation

the options available for defining the direction

Enumerator
DirectionTypeSelection 

Select a coordinate system (-Z) or plane for the direction.

DirectionTypeCoordinateSystem 

Define a coordinate system (-Z) for the direction.

DirectionTypeVector 

Define a vector for the direction.

Member Function Documentation

NXOpen::Matrix3x3 NXOpen::Die::DieDirectionBuilder::CoordinateSystemMatrix ( )

Returns the coordinate system matrix
Created in NX6.0.0.



License requirements : None

NXOpen::Point3d NXOpen::Die::DieDirectionBuilder::CoordinateSystemOrigin ( )

Returns the coordinate system origin
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObject* NXOpen::Die::DieDirectionBuilder::Direction ( )

Returns the selected direction
Created in NX6.0.0.



License requirements : None

NXOpen::Die::DieDirectionBuilder::DirectionType NXOpen::Die::DieDirectionBuilder::InputType ( )

Returns the type of input that defined the direction
Created in NX7.5.0.



License requirements : None

bool NXOpen::Die::DieDirectionBuilder::ReverseSourceDirection ( )

Returns the indication if the source's direction should be reversed.

True indicates the source's direction should be reversed
Created in NX6.0.0.

License requirements : None

void NXOpen::Die::DieDirectionBuilder::SetCoordinateSystemMatrix ( const NXOpen::Matrix3x3 coordinateSystemMatrix)

Sets the coordinate system matrix
Created in NX6.0.0.



License requirements : None

Parameters
coordinateSystemMatrixcoordinatesystemmatrix
void NXOpen::Die::DieDirectionBuilder::SetCoordinateSystemOrigin ( const NXOpen::Point3d coordinateSystemOrigin)

Sets the coordinate system origin
Created in NX6.0.0.



License requirements : None

Parameters
coordinateSystemOrigincoordinatesystemorigin
void NXOpen::Die::DieDirectionBuilder::SetInputType ( NXOpen::Die::DieDirectionBuilder::DirectionType  inputType)

Sets the type of input that defined the direction
Created in NX7.5.0.



License requirements : None

Parameters
inputTypeinputtype
void NXOpen::Die::DieDirectionBuilder::SetReverseSourceDirection ( bool  reverseSourceDirection)

Sets the indication if the source's direction should be reversed.

True indicates the source's direction should be reversed
Created in NX6.0.0.

License requirements : None

Parameters
reverseSourceDirectionreversesourcedirection
void NXOpen::Die::DieDirectionBuilder::SetVector ( NXOpen::Direction vector)

Sets the specified vector
Created in NX6.0.0.



License requirements : None

Parameters
vectorvector
virtual bool NXOpen::Die::DieDirectionBuilder::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::Die::DieDirectionBuilder::Vector ( )

Returns the specified vector
Created in NX6.0.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.