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

Represents a Die::DiePlaneBuilder . More...

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

List of all members.

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.
NXOpen::Point3d CoordinateSystemOrigin ()
 Returns the coordinate system origin
Created in NX6.0.0.
NXOpen::Die::DiePlaneBuilder::PlaneType InputType ()
 Returns the type of input that defined the plane
Created in NX7.5.0.
bool ReverseSourceDirection ()
 Returns the indication if the source's direction should be reversed.
NXOpen::SelectNXObjectSelectPlane ()
 Returns the selected plane
Created in NX6.0.0.
void SetCoordinateSystemMatrix (const NXOpen::Matrix3x3 &coordinateSystemMatrix)
 Sets the coordinate system matrix
Created in NX6.0.0.
void SetCoordinateSystemOrigin (const NXOpen::Point3d &coordinateSystemOrigin)
 Sets the coordinate system origin
Created in NX6.0.0.
void SetInputType (NXOpen::Die::DiePlaneBuilder::PlaneType inputType)
 Sets the type of input that defined the plane
Created in NX7.5.0.
void SetReverseSourceDirection (bool reverseSourceDirection)
 Sets the indication if the source's direction should be reversed.
void SetSourceDataType (NXOpen::Die::DiePlaneBuilder::PlaneType sourceDataType)
 Sets the type of source that defined the plane.
void SetSpecifyPlane (NXOpen::Plane *specifyPlane)
 Sets the specified plane
Created in NX6.0.0.
NXOpen::Die::DiePlaneBuilder::PlaneType SourceDataType ()
 Returns the type of source that defined the plane.
NXOpen::PlaneSpecifyPlane ()
 Returns the specified plane
Created in NX6.0.0.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.

Detailed Description

Represents a 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 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

Returns the coordinate system matrix
Created in NX6.0.0.



License requirements : None

Returns the coordinate system origin
Created in NX6.0.0.



License requirements : None

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



License requirements : None

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

Returns the selected plane
Created in NX6.0.0.



License requirements : None

Sets the coordinate system matrix
Created in NX6.0.0.



License requirements : ug_die_design ("Die Design")

Parameters:
coordinateSystemMatrixcoordinatesystemmatrix

Sets the coordinate system origin
Created in NX6.0.0.



License requirements : ug_die_design ("Die Design")

Parameters:
coordinateSystemOrigincoordinatesystemorigin

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

Sets the type of source that defined the plane.

Functions are obsolete, please use input_type.

Deprecated:
Deprecated in NX7.0.0.


Created in NX6.0.0.

License requirements : ug_die_design ("Die Design")

Parameters:
sourceDataTypesourcedatatype

Sets the specified plane
Created in NX6.0.0.



License requirements : ug_die_design ("Die Design")

Parameters:
specifyPlanespecifyplane

Returns the type of source that defined the plane.

Functions are obsolete, please use input_type.

Deprecated:
Deprecated in NX7.0.0.


Created in NX6.0.0.

License requirements : None

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 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.