NXOpen::Mechatronics::AlignBodyBuilder Class Reference

Represents a NXOpen::Mechatronics::AlignBody builder. More...

Inheritance diagram for NXOpen::Mechatronics::AlignBodyBuilder:

Public Types
enum	RoleType { RoleTypeSource, RoleTypeTarget }
	the Snap role types. More...

Public Member Functions
NXOpen::Mechatronics::SelectRigidBody *	AttachBody ()
	Returns. More...
NXOpen::Point *	AttachPoint ()
	Returns. More...
int	Category ()
	Returns. More...
NXString	JunctionName ()
	Returns. More...
NXString	Name ()
	Returns. More...
NXOpen::CoordinateSystem *	Orientation ()
	Returns. More...
NXOpen::Expression *	Proximity ()
	Returns. More...
void	SetAttachbody (NXOpen::NXObject *rigid)
	Sets the attached rigid body. More...
void	SetAttachPoint (NXOpen::Point *attachPoint)
	Sets. More...
void	SetCategory (int category)
	Sets. More...
void	SetJunctionName (const NXString &junction)
	Sets. More...
void	SetJunctionName (const char *junction)
	Sets. More...
void	SetName (const NXString &name)
	Sets. More...
void	SetName (const char *name)
	Sets. More...
void	SetOrientation (NXOpen::CoordinateSystem *orientation)
	Sets. More...
void	SetSnapRole (NXOpen::Mechatronics::AlignBodyBuilder::RoleType roleType)
	Sets. More...
NXOpen::Mechatronics::AlignBodyBuilder::RoleType	SnapRole ()
	Returns. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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 NXOpen::Mechatronics::AlignBody builder.

To create a new instance of this class, use NXOpen::Mechatronics::AlignBodyCollection::CreateAlignBodyBuilder

Created in NX12.0.0.

Member Enumeration Documentation

enum NXOpen::Mechatronics::AlignBodyBuilder::RoleType

the Snap role types.

Enumerator
RoleTypeSource	Source.
RoleTypeTarget	Target.

Member Function Documentation

NXOpen::Mechatronics::SelectRigidBody* NXOpen::Mechatronics::AlignBodyBuilder::AttachBody

(

)

Returns.

the rigid body which snap point attaches on. This should be a NXOpen::Mechatronics::RigidBody

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Point* NXOpen::Mechatronics::AlignBodyBuilder::AttachPoint

(

)

Returns.

the positioning of snap point.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

int NXOpen::Mechatronics::AlignBodyBuilder::Category

(

)

Returns.

the category. It should be an integer bigger or equal to zero.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::AlignBodyBuilder::JunctionName

(

)

Returns.

the junction name converted from MTB.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXString NXOpen::Mechatronics::AlignBodyBuilder::Name

(

)

Returns.

the name.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::CoordinateSystem* NXOpen::Mechatronics::AlignBodyBuilder::Orientation

(

)

Returns.

the orientation of snap point.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::AlignBodyBuilder::Proximity

(

)

Returns.

the proximity for distance detection.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::AlignBodyBuilder::SetAttachbody

(

NXOpen::NXObject *

rigid

)

Sets the attached rigid body.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

rigid

rigid

void NXOpen::Mechatronics::AlignBodyBuilder::SetAttachPoint

(

NXOpen::Point *

attachPoint

)

Sets.

the positioning of snap point.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

attachPoint

attachpoint

void NXOpen::Mechatronics::AlignBodyBuilder::SetCategory

(

int

category

)

Sets.

the category. It should be an integer bigger or equal to zero.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

category

category

void NXOpen::Mechatronics::AlignBodyBuilder::SetJunctionName

(

const NXString &

junction

)

Sets.

the junction name converted from MTB.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

junction

junction

void NXOpen::Mechatronics::AlignBodyBuilder::SetJunctionName

(

const char *

junction

)

Sets.

the junction name converted from MTB.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

junction

junction

void NXOpen::Mechatronics::AlignBodyBuilder::SetName

(

const NXString &

name

)

Sets.

the name.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name

name

void NXOpen::Mechatronics::AlignBodyBuilder::SetName

(

const char *

name

)

Sets.

the name.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

name

name

void NXOpen::Mechatronics::AlignBodyBuilder::SetOrientation

(

NXOpen::CoordinateSystem *

orientation

)

Sets.

the orientation of snap point.

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

orientation

orientation

void NXOpen::Mechatronics::AlignBodyBuilder::SetSnapRole

(

NXOpen::Mechatronics::AlignBodyBuilder::RoleType

roleType

)

Sets.

the role type

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

roleType

roletype

NXOpen::Mechatronics::AlignBodyBuilder::RoleType NXOpen::Mechatronics::AlignBodyBuilder::SnapRole

(

)

Returns.

the role type

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

---

The documentation for this class was generated from the following file:

• Mechatronics_AlignBodyBuilder.hxx