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

Represents a NXOpen::AnimationDesigner::GearBuilder . More...

Inheritance diagram for NXOpen::AnimationDesigner::GearBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  GearType { GearTypeGeneral, GearTypeChainbelt, GearTypeCable }
 Definitions of gear type. More...
 

Public Member Functions

bool ChangeDirection ()
 Returns the inner gear option. More...
 
NXOpen::ExpressionExpressionRatio ()
 Returns the ratio expression. More...
 
NXOpen::SelectNXObjectMasterAxisJoint ()
 Returns the master axis joint. More...
 
NXString Name ()
 Returns the name. More...
 
void SetChangeDirection (bool change)
 Sets the inner gear option. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. More...
 
void SetUseType (NXOpen::AnimationDesigner::GearBuilder::GearType useType)
 Sets the gear type. More...
 
NXOpen::SelectNXObjectSlaveAxisJoint ()
 Returns the slave axis joint. More...
 
NXOpen::AnimationDesigner::GearBuilder::GearType UseType ()
 Returns the gear type. 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 NXOpen::AnimationDesigner::GearBuilder .


To create a new instance of this class, use NXOpen::AnimationDesigner::GearCollection::CreateGearBuilder

Created in NX12.0.0.

Member Enumeration Documentation

Definitions of gear type.

Enumerator
GearTypeGeneral 

general gear

GearTypeChainbelt 

chain belt

GearTypeCable 

cable

Member Function Documentation

bool NXOpen::AnimationDesigner::GearBuilder::ChangeDirection ( )

Returns the inner gear option.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::Expression* NXOpen::AnimationDesigner::GearBuilder::ExpressionRatio ( )

Returns the ratio expression.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::SelectNXObject* NXOpen::AnimationDesigner::GearBuilder::MasterAxisJoint ( )

Returns the master axis joint.

This can be a NXOpen::AnimationDesigner::RevoluteJoint or NXOpen::AnimationDesigner::CylindricalJoint .
Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXString NXOpen::AnimationDesigner::GearBuilder::Name ( )

Returns the name.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

void NXOpen::AnimationDesigner::GearBuilder::SetChangeDirection ( bool  change)

Sets the inner gear option.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
changechange
void NXOpen::AnimationDesigner::GearBuilder::SetName ( const NXString name)

Sets the name.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
namename
void NXOpen::AnimationDesigner::GearBuilder::SetName ( const char *  name)

Sets the name.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
namename
void NXOpen::AnimationDesigner::GearBuilder::SetUseType ( NXOpen::AnimationDesigner::GearBuilder::GearType  useType)

Sets the gear type.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
useTypeusetype
NXOpen::SelectNXObject* NXOpen::AnimationDesigner::GearBuilder::SlaveAxisJoint ( )

Returns the slave axis joint.

This can be a NXOpen::AnimationDesigner::RevoluteJoint or NXOpen::AnimationDesigner::CylindricalJoint .
Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::AnimationDesigner::GearBuilder::GearType NXOpen::AnimationDesigner::GearBuilder::UseType ( )

Returns the gear type.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.