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

Represents a NXOpen::Die::DiePlaneBuilder . More...

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

Public Types

enum  PlaneType { PlaneTypeSelection, PlaneTypePlane, PlaneTypeCoordinateSystem }
 the options available for defining the plane 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::Die::DiePlaneBuilder::PlaneType InputType ()
 Returns the type of input that defined the plane
Created in NX7.5.0. More...
 
bool ReverseSourceDirection ()
 Returns the indication if the source's direction should be reversed. More...
 
NXOpen::SelectNXObjectSelectPlane ()
 Returns the selected plane
Created in NX6.0.0. 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::DiePlaneBuilder::PlaneType inputType)
 Sets the type of input that defined the plane
Created in NX7.5.0. More...
 
void SetReverseSourceDirection (bool reverseSourceDirection)
 Sets the indication if the source's direction should be reversed. More...
 
void SetSpecifyPlane (NXOpen::Plane *specifyPlane)
 Sets the specified plane
Created in NX6.0.0. More...
 
NXOpen::PlaneSpecifyPlane ()
 Returns the specified plane
Created in NX6.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 NXOpen::Die::DiePlaneBuilder .

The Die Plane is a helper to the main Die Design feature to specify the plane, such as the base plane or end planes. If a coordinate system is specified, then the XY plane of the coordinate system will be used.
To create a new instance of this class, use NXOpen::Die::DieCollection::CreateDiePlane

Created in NX6.0.0.

Member Enumeration Documentation

the options available for defining the plane

Enumerator
PlaneTypeSelection 

Select the plane to be used.

PlaneTypePlane 

Define the plane to be used.

PlaneTypeCoordinateSystem 

Define a coordinate system to specify the plane.

Member Function Documentation

NXOpen::Matrix3x3 NXOpen::Die::DiePlaneBuilder::CoordinateSystemMatrix ( )

Returns the coordinate system matrix
Created in NX6.0.0.



License requirements : None

NXOpen::Point3d NXOpen::Die::DiePlaneBuilder::CoordinateSystemOrigin ( )

Returns the coordinate system origin
Created in NX6.0.0.



License requirements : None

NXOpen::Die::DiePlaneBuilder::PlaneType NXOpen::Die::DiePlaneBuilder::InputType ( )

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



License requirements : None

bool NXOpen::Die::DiePlaneBuilder::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

NXOpen::SelectNXObject* NXOpen::Die::DiePlaneBuilder::SelectPlane ( )

Returns the selected plane
Created in NX6.0.0.



License requirements : None

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

Sets the coordinate system matrix
Created in NX6.0.0.



License requirements : ug_die_design ("Die Design")

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

Sets the coordinate system origin
Created in NX6.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
coordinateSystemOrigincoordinatesystemorigin
void NXOpen::Die::DiePlaneBuilder::SetInputType ( NXOpen::Die::DiePlaneBuilder::PlaneType  inputType)

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



License requirements : ug_die_design ("Die Design")

Parameters
inputTypeinputtype
void NXOpen::Die::DiePlaneBuilder::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 : ug_die_design ("Die Design")

Parameters
reverseSourceDirectionreversesourcedirection
void NXOpen::Die::DiePlaneBuilder::SetSpecifyPlane ( NXOpen::Plane specifyPlane)

Sets the specified plane
Created in NX6.0.0.



License requirements : ug_die_design ("Die Design")

Parameters
specifyPlanespecifyplane
NXOpen::Plane* NXOpen::Die::DiePlaneBuilder::SpecifyPlane ( )

Returns the specified plane
Created in NX6.0.0.



License requirements : None

virtual bool NXOpen::Die::DiePlaneBuilder::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.