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

Represents a Tooling::LayoutBuilder builder
To create a new instance of this class, use NXOpen::Tooling::MWLayoutCollection::CreateLayoutBuilder
Default values. More...

Inheritance diagram for NXOpen::Tooling::LayoutBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  BalNumber { BalNumberTwo, BalNumberFour }
 Represents the number of balance cavity. More...
 
enum  LayoutSubType { LayoutSubTypeBalance, LayoutSubTypeLinear, LayoutSubTypeRadial, LayoutSubTypeConstant }
 Represents the the sub type of layout. More...
 
enum  LayoutType { LayoutTypeRectangle, LayoutTypeCircular }
 Represents the type of layout. More...
 
enum  XrefNum { XrefNumBlock, XrefNumMove }
 Represents the type of x move refer. More...
 
enum  YrefNum { YrefNumBlock, YrefNumMove }
 Represents the type of y move refer. More...
 

Public Member Functions

void Autocenter ()
 Make center of cavity
Created in NX6.0.0. More...
 
NXOpen::Tooling::LayoutBuilder::BalNumber BalCavityNumber ()
 Returns the balance cavity number
Created in NX6.0.0. More...
 
int CirCavityNumber ()
 Returns the copy number for circular transform
Created in NX6.0.0. More...
 
double CirRadius ()
 Returns the radius value
Created in NX6.0.0. More...
 
double CirRotateAngle ()
 Returns the rotate angle
Created in NX6.0.0. More...
 
double CirStartAngle ()
 Returns the start angle
Created in NX6.0.0. More...
 
NXOpen::ExpressionDimBalFirst ()
 Returns the first dimension for balance transform
Created in NX6.0.0. More...
 
NXOpen::ExpressionDimBalSecond ()
 Returns the second dimension for balance transform
Created in NX6.0.0. More...
 
NXOpen::ExpressionDimXdist ()
 Returns the cavity distance dimension in X-axis
Created in NX6.0.0. More...
 
NXOpen::ExpressionDimYdist ()
 Returns the cavity distance dimension in Y-axis
Created in NX6.0.0. More...
 
void Insertpocket ()
 Insert pocket
Created in NX6.0.0. More...
 
void Layout ()
 Perform cavity layout
Created in NX6.0.0. More...
 
NXOpen::DirectionLayoutVector ()
 Returns the rotate vector
Created in NX6.0.0. More...
 
int LinXnumber ()
 Returns the copy number for linear transform in X-axis
Created in NX6.0.0. More...
 
int LinYnumber ()
 Returns the copy number for linear transform in Y-axis
Created in NX6.0.0. More...
 
NXOpen::Tooling::LayoutBuilder::LayoutType MwLayoutType ()
 Returns the layout pattern type
Created in NX6.0.0. More...
 
void Remove ()
 Remove cavity
Created in NX6.0.0. More...
 
NXOpen::PointRotatePoint ()
 Returns the rotate point
Created in NX6.0.0. More...
 
NXOpen::SelectBodyListSelectCavity ()
 Returns the select cavity
Created in NX6.0.0. More...
 
void SetBalCavityNumber (NXOpen::Tooling::LayoutBuilder::BalNumber enumBalCavityNumber)
 Sets the balance cavity number
Created in NX6.0.0. More...
 
void SetCirCavityNumber (int cirCavityNumber)
 Sets the copy number for circular transform
Created in NX6.0.0. More...
 
void SetCirRadius (double cirRadius)
 Sets the radius value
Created in NX6.0.0. More...
 
void SetCirRotateAngle (double cirRotateAngle)
 Sets the rotate angle
Created in NX6.0.0. More...
 
void SetCirStartAngle (double cirStartAngle)
 Sets the start angle
Created in NX6.0.0. More...
 
void SetLayoutVector (NXOpen::Direction *layoutVector)
 Sets the rotate vector
Created in NX6.0.0. More...
 
void SetLinXnumber (int linXNumber)
 Sets the copy number for linear transform in X-axis
Created in NX6.0.0. More...
 
void SetLinYnumber (int linYNumber)
 Sets the copy number for linear transform in Y-axis
Created in NX6.0.0. More...
 
void SetMwLayoutType (NXOpen::Tooling::LayoutBuilder::LayoutType enumLayoutType)
 Sets the layout pattern type
Created in NX6.0.0. More...
 
void SetRotatePoint (NXOpen::Point *rotatePoint)
 Sets the rotate point
Created in NX6.0.0. More...
 
void SetSubType (NXOpen::Tooling::LayoutBuilder::LayoutSubType enumSubType)
 Sets the layout transform type
Created in NX6.0.0. More...
 
void SetXref (NXOpen::Tooling::LayoutBuilder::XrefNum enumXRef)
 Sets the layout cavity number in X-axis
Created in NX6.0.0. More...
 
void SetYref (NXOpen::Tooling::LayoutBuilder::YrefNum enumYRef)
 Sets the layout cavity number in Y-axis
Created in NX6.0.0. More...
 
NXOpen::Tooling::LayoutBuilder::LayoutSubType SubType ()
 Returns the layout transform type
Created in NX6.0.0. More...
 
void Transform ()
 Reposition cavity
Created in NX6.0.0. More...
 
NXOpen::Tooling::LayoutBuilder::XrefNum Xref ()
 Returns the layout cavity number in X-axis
Created in NX6.0.0. More...
 
NXOpen::Tooling::LayoutBuilder::YrefNum Yref ()
 Returns the layout cavity number in Y-axis
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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 Tooling::LayoutBuilder builder
To create a new instance of this class, use NXOpen::Tooling::MWLayoutCollection::CreateLayoutBuilder
Default values.

Property Value

CirCavityNumber

2

CirRadius

0

CirRotateAngle

360

CirStartAngle

0

DimBalFirst.Value

0 (millimeters part), 0 (inches part)

LinXnumber

2

LinYnumber

1


Created in NX6.0.0.

Member Enumeration Documentation

Represents the number of balance cavity.

Enumerator
BalNumberTwo 

Two balance cavities.

BalNumberFour 

Four balance cavities.

Represents the the sub type of layout.

Enumerator
LayoutSubTypeBalance 

Balance type.

LayoutSubTypeLinear 

Linear type.

LayoutSubTypeRadial 

Radial circular type.

LayoutSubTypeConstant 

Constanct circular type.

Represents the type of layout.

Enumerator
LayoutTypeRectangle 

Rectangle layout.

LayoutTypeCircular 

Circle layout.

Represents the type of x move refer.

Enumerator
XrefNumBlock 

Block type.

XrefNumMove 

Move type.

Represents the type of y move refer.

Enumerator
YrefNumBlock 

Block type.

YrefNumMove 

Move type.

Member Function Documentation

void NXOpen::Tooling::LayoutBuilder::Autocenter ( )

Make center of cavity
Created in NX6.0.0.



License requirements : None

NXOpen::Tooling::LayoutBuilder::BalNumber NXOpen::Tooling::LayoutBuilder::BalCavityNumber ( )

Returns the balance cavity number
Created in NX6.0.0.



License requirements : None

int NXOpen::Tooling::LayoutBuilder::CirCavityNumber ( )

Returns the copy number for circular transform
Created in NX6.0.0.



License requirements : None

double NXOpen::Tooling::LayoutBuilder::CirRadius ( )

Returns the radius value
Created in NX6.0.0.



License requirements : None

double NXOpen::Tooling::LayoutBuilder::CirRotateAngle ( )

Returns the rotate angle
Created in NX6.0.0.



License requirements : None

double NXOpen::Tooling::LayoutBuilder::CirStartAngle ( )

Returns the start angle
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Tooling::LayoutBuilder::DimBalFirst ( )

Returns the first dimension for balance transform
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Tooling::LayoutBuilder::DimBalSecond ( )

Returns the second dimension for balance transform
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Tooling::LayoutBuilder::DimXdist ( )

Returns the cavity distance dimension in X-axis
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Tooling::LayoutBuilder::DimYdist ( )

Returns the cavity distance dimension in Y-axis
Created in NX6.0.0.



License requirements : None

void NXOpen::Tooling::LayoutBuilder::Insertpocket ( )

Insert pocket
Created in NX6.0.0.



License requirements : None

void NXOpen::Tooling::LayoutBuilder::Layout ( )

Perform cavity layout
Created in NX6.0.0.



License requirements : None

NXOpen::Direction* NXOpen::Tooling::LayoutBuilder::LayoutVector ( )

Returns the rotate vector
Created in NX6.0.0.



License requirements : None

int NXOpen::Tooling::LayoutBuilder::LinXnumber ( )

Returns the copy number for linear transform in X-axis
Created in NX6.0.0.



License requirements : None

int NXOpen::Tooling::LayoutBuilder::LinYnumber ( )

Returns the copy number for linear transform in Y-axis
Created in NX6.0.0.



License requirements : None

NXOpen::Tooling::LayoutBuilder::LayoutType NXOpen::Tooling::LayoutBuilder::MwLayoutType ( )

Returns the layout pattern type
Created in NX6.0.0.



License requirements : None

void NXOpen::Tooling::LayoutBuilder::Remove ( )

Remove cavity
Created in NX6.0.0.



License requirements : None

NXOpen::Point* NXOpen::Tooling::LayoutBuilder::RotatePoint ( )

Returns the rotate point
Created in NX6.0.0.



License requirements : None

NXOpen::SelectBodyList* NXOpen::Tooling::LayoutBuilder::SelectCavity ( )

Returns the select cavity
Created in NX6.0.0.



License requirements : None

void NXOpen::Tooling::LayoutBuilder::SetBalCavityNumber ( NXOpen::Tooling::LayoutBuilder::BalNumber  enumBalCavityNumber)

Sets the balance cavity number
Created in NX6.0.0.



License requirements : None

Parameters
enumBalCavityNumberenumbalcavitynumber
void NXOpen::Tooling::LayoutBuilder::SetCirCavityNumber ( int  cirCavityNumber)

Sets the copy number for circular transform
Created in NX6.0.0.



License requirements : None

Parameters
cirCavityNumbercircavitynumber
void NXOpen::Tooling::LayoutBuilder::SetCirRadius ( double  cirRadius)

Sets the radius value
Created in NX6.0.0.



License requirements : None

Parameters
cirRadiuscirradius
void NXOpen::Tooling::LayoutBuilder::SetCirRotateAngle ( double  cirRotateAngle)

Sets the rotate angle
Created in NX6.0.0.



License requirements : None

Parameters
cirRotateAnglecirrotateangle
void NXOpen::Tooling::LayoutBuilder::SetCirStartAngle ( double  cirStartAngle)

Sets the start angle
Created in NX6.0.0.



License requirements : None

Parameters
cirStartAnglecirstartangle
void NXOpen::Tooling::LayoutBuilder::SetLayoutVector ( NXOpen::Direction layoutVector)

Sets the rotate vector
Created in NX6.0.0.



License requirements : None

Parameters
layoutVectorlayoutvector
void NXOpen::Tooling::LayoutBuilder::SetLinXnumber ( int  linXNumber)

Sets the copy number for linear transform in X-axis
Created in NX6.0.0.



License requirements : None

Parameters
linXNumberlinxnumber
void NXOpen::Tooling::LayoutBuilder::SetLinYnumber ( int  linYNumber)

Sets the copy number for linear transform in Y-axis
Created in NX6.0.0.



License requirements : None

Parameters
linYNumberlinynumber
void NXOpen::Tooling::LayoutBuilder::SetMwLayoutType ( NXOpen::Tooling::LayoutBuilder::LayoutType  enumLayoutType)

Sets the layout pattern type
Created in NX6.0.0.



License requirements : None

Parameters
enumLayoutTypeenumlayouttype
void NXOpen::Tooling::LayoutBuilder::SetRotatePoint ( NXOpen::Point rotatePoint)

Sets the rotate point
Created in NX6.0.0.



License requirements : None

Parameters
rotatePointrotatepoint
void NXOpen::Tooling::LayoutBuilder::SetSubType ( NXOpen::Tooling::LayoutBuilder::LayoutSubType  enumSubType)

Sets the layout transform type
Created in NX6.0.0.



License requirements : None

Parameters
enumSubTypeenumsubtype
void NXOpen::Tooling::LayoutBuilder::SetXref ( NXOpen::Tooling::LayoutBuilder::XrefNum  enumXRef)

Sets the layout cavity number in X-axis
Created in NX6.0.0.



License requirements : None

Parameters
enumXRefenumxref
void NXOpen::Tooling::LayoutBuilder::SetYref ( NXOpen::Tooling::LayoutBuilder::YrefNum  enumYRef)

Sets the layout cavity number in Y-axis
Created in NX6.0.0.



License requirements : None

Parameters
enumYRefenumyref
NXOpen::Tooling::LayoutBuilder::LayoutSubType NXOpen::Tooling::LayoutBuilder::SubType ( )

Returns the layout transform type
Created in NX6.0.0.



License requirements : None

void NXOpen::Tooling::LayoutBuilder::Transform ( )

Reposition cavity
Created in NX6.0.0.



License requirements : None

NXOpen::Tooling::LayoutBuilder::XrefNum NXOpen::Tooling::LayoutBuilder::Xref ( )

Returns the layout cavity number in X-axis
Created in NX6.0.0.



License requirements : None

NXOpen::Tooling::LayoutBuilder::YrefNum NXOpen::Tooling::LayoutBuilder::Yref ( )

Returns the layout cavity number in Y-axis
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.