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

Represents a NXOpen::AnimationDesigner::RigidGroupBuilder . More...

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

Public Types

enum  ColorOptions { ColorOptionsSpecifyColor, ColorOptionsAutomaticColor, ColorOptionsNoColor }
 the color options. More...
 
enum  CreationTypes { CreationTypesCombine, CreationTypesSeparate }
 the creation types. More...
 
enum  MassPropertiesOption { MassPropertiesOptionAutomatic, MassPropertiesOptionUserDefined }
 the mass property options. More...
 

Public Member Functions

NXOpen::DirectionAngularVelocityDirection ()
 Returns the angular velocity direction. More...
 
NXOpen::ExpressionAngularVelocityMagnitude ()
 Returns the angular velocity magnitude. More...
 
NXOpen::NXColorColor ()
 Returns the color. More...
 
NXOpen::AnimationDesigner::RigidGroupBuilder::ColorOptions ColorOption ()
 Returns the color option. More...
 
NXOpen::AnimationDesigner::RigidGroupBuilder::CreationTypes CreationType ()
 Returns the creation type. More...
 
NXOpen::SelectNXObjectListGeometry ()
 Returns the geometries. More...
 
NXOpen::ExpressionInertiaIxx ()
 Returns the inertia Ixx. More...
 
NXOpen::ExpressionInertiaIxy ()
 Returns the inertia Ixy. More...
 
NXOpen::ExpressionInertiaIxz ()
 Returns the inertia Ixz. More...
 
NXOpen::ExpressionInertiaIyy ()
 Returns the inertia Iyy. More...
 
NXOpen::ExpressionInertiaIyz ()
 Returns the inertia Iyz. More...
 
NXOpen::ExpressionInertiaIzz ()
 Returns the inertia Izz. More...
 
NXOpen::DirectionLinearVelocityDirection ()
 Returns the linear velocity. More...
 
NXOpen::ExpressionLinearVelocityMagnitude ()
 Returns the linear velocity magnitude. More...
 
NXOpen::ExpressionMass ()
 Returns the mass. More...
 
NXOpen::PointMassCenterPoint ()
 Returns the mass center point. More...
 
NXOpen::AnimationDesigner::RigidGroupBuilder::MassPropertiesOption MassProperty ()
 Returns the auto-calculate mass property flag which is used to indicate whether all mass properties are calculated by system. More...
 
NXString Name ()
 Returns the name. More...
 
NXOpen::CoordinateSystemOrientation ()
 Returns the orientation. More...
 
void SetAngularVelocityDirection (NXOpen::Direction *dir)
 Sets the angular velocity direction. More...
 
void SetColor (NXOpen::NXColor *color)
 Sets the color. More...
 
void SetColorOption (NXOpen::AnimationDesigner::RigidGroupBuilder::ColorOptions colorOption)
 Sets the color option. More...
 
void SetCreationType (NXOpen::AnimationDesigner::RigidGroupBuilder::CreationTypes creationType)
 Sets the creation type. More...
 
void SetLinearVelocityDirection (NXOpen::Direction *dir)
 Sets the linear velocity. More...
 
void SetMassCenterPoint (NXOpen::Point *center)
 Sets the mass center point. More...
 
void SetMassProperty (NXOpen::AnimationDesigner::RigidGroupBuilder::MassPropertiesOption massProperty)
 Sets the auto-calculate mass property flag which is used to indicate whether all mass properties are calculated by system. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. More...
 
void SetOrientation (NXOpen::CoordinateSystem *orientation)
 Sets the orientation. 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::RigidGroupBuilder .


To create a new instance of this class, use NXOpen::AnimationDesigner::RigidGroupCollection::CreateRigidGroupBuilder

Created in NX12.0.0.

Member Enumeration Documentation

the color options.

Enumerator
ColorOptionsSpecifyColor 

Assigns a color to the group.

ColorOptionsAutomaticColor 

Auto-assigns a color to each group.

ColorOptionsNoColor 

Assigns no color to the groups.

the creation types.

Enumerator
CreationTypesCombine 

Combine selections into one Rigid Group.

CreationTypesSeparate 

Create a Rigid Group for each selection.

the mass property options.

Enumerator
MassPropertiesOptionAutomatic 

automatic

MassPropertiesOptionUserDefined 

user defined

Member Function Documentation

NXOpen::Direction* NXOpen::AnimationDesigner::RigidGroupBuilder::AngularVelocityDirection ( )

Returns the angular velocity direction.

It is only used when angular velocity is not zero.
Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::Expression* NXOpen::AnimationDesigner::RigidGroupBuilder::AngularVelocityMagnitude ( )

Returns the angular velocity magnitude.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::NXColor* NXOpen::AnimationDesigner::RigidGroupBuilder::Color ( )

Returns the color.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::AnimationDesigner::RigidGroupBuilder::ColorOptions NXOpen::AnimationDesigner::RigidGroupBuilder::ColorOption ( )

Returns the color option.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::AnimationDesigner::RigidGroupBuilder::CreationTypes NXOpen::AnimationDesigner::RigidGroupBuilder::CreationType ( )

Returns the creation type.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::SelectNXObjectList* NXOpen::AnimationDesigner::RigidGroupBuilder::Geometry ( )

Returns the geometries.

This can be a NXOpen::Assemblies::ComponentAssembly , NXOpen::Point , bodies and curve.
Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::Expression* NXOpen::AnimationDesigner::RigidGroupBuilder::InertiaIxx ( )

Returns the inertia Ixx.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::Expression* NXOpen::AnimationDesigner::RigidGroupBuilder::InertiaIxy ( )

Returns the inertia Ixy.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::Expression* NXOpen::AnimationDesigner::RigidGroupBuilder::InertiaIxz ( )

Returns the inertia Ixz.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::Expression* NXOpen::AnimationDesigner::RigidGroupBuilder::InertiaIyy ( )

Returns the inertia Iyy.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::Expression* NXOpen::AnimationDesigner::RigidGroupBuilder::InertiaIyz ( )

Returns the inertia Iyz.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::Expression* NXOpen::AnimationDesigner::RigidGroupBuilder::InertiaIzz ( )

Returns the inertia Izz.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::Direction* NXOpen::AnimationDesigner::RigidGroupBuilder::LinearVelocityDirection ( )

Returns the linear velocity.

It is only used when linear velocity is not zero.
Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::Expression* NXOpen::AnimationDesigner::RigidGroupBuilder::LinearVelocityMagnitude ( )

Returns the linear velocity magnitude.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::Expression* NXOpen::AnimationDesigner::RigidGroupBuilder::Mass ( )

Returns the mass.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::Point* NXOpen::AnimationDesigner::RigidGroupBuilder::MassCenterPoint ( )

Returns the mass center point.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::AnimationDesigner::RigidGroupBuilder::MassPropertiesOption NXOpen::AnimationDesigner::RigidGroupBuilder::MassProperty ( )

Returns the auto-calculate mass property flag which is used to indicate whether all mass properties are calculated by system.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXString NXOpen::AnimationDesigner::RigidGroupBuilder::Name ( )

Returns the name.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::CoordinateSystem* NXOpen::AnimationDesigner::RigidGroupBuilder::Orientation ( )

Returns the orientation.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

void NXOpen::AnimationDesigner::RigidGroupBuilder::SetAngularVelocityDirection ( NXOpen::Direction dir)

Sets the angular velocity direction.

It is only used when angular velocity is not zero.
Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
dirdir
void NXOpen::AnimationDesigner::RigidGroupBuilder::SetColor ( NXOpen::NXColor color)

Sets the color.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
colorcolor
void NXOpen::AnimationDesigner::RigidGroupBuilder::SetColorOption ( NXOpen::AnimationDesigner::RigidGroupBuilder::ColorOptions  colorOption)

Sets the color option.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
colorOptioncoloroption
void NXOpen::AnimationDesigner::RigidGroupBuilder::SetCreationType ( NXOpen::AnimationDesigner::RigidGroupBuilder::CreationTypes  creationType)

Sets the creation type.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
creationTypecreationtype
void NXOpen::AnimationDesigner::RigidGroupBuilder::SetLinearVelocityDirection ( NXOpen::Direction dir)

Sets the linear velocity.

It is only used when linear velocity is not zero.
Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
dirdir
void NXOpen::AnimationDesigner::RigidGroupBuilder::SetMassCenterPoint ( NXOpen::Point center)

Sets the mass center point.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
centercenter
void NXOpen::AnimationDesigner::RigidGroupBuilder::SetMassProperty ( NXOpen::AnimationDesigner::RigidGroupBuilder::MassPropertiesOption  massProperty)

Sets the auto-calculate mass property flag which is used to indicate whether all mass properties are calculated by system.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
massPropertymassproperty
void NXOpen::AnimationDesigner::RigidGroupBuilder::SetName ( const NXString name)

Sets the name.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

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

Sets the name.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
namename
void NXOpen::AnimationDesigner::RigidGroupBuilder::SetOrientation ( NXOpen::CoordinateSystem orientation)

Sets the orientation.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
orientationorientation

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