NXOpen::AnimationDesigner::AnimatedExplodeBuilder Class Reference

Represents a NXOpen::AnimationDesigner::AnimatedExplodeBuilder . More...

Inheritance diagram for NXOpen::AnimationDesigner::AnimatedExplodeBuilder:

Public Types
enum	ColorOptions { ColorOptionsSpecifyColor, ColorOptionsAutomaticColor, ColorOptionsNoColor }
	the color options. More...
enum	CreationTypes { CreationTypesCombine, CreationTypesSeparate }
	the creation types. More...

Public Member Functions
NXOpen::NXColor *	Color ()
	Returns the color. More...
NXOpen::AnimationDesigner::AnimatedExplodeBuilder::ColorOptions	ColorOption ()
	Returns the color option. More...
NXOpen::AnimationDesigner::AnimatedExplodeBuilder::CreationTypes	CreationType ()
	Returns the creation type. More...
void	DeleteStep (int pos)
	Deletes the step. More...
int	GetStepCount ()
	Gets the step count. More...
void	InsertStep (int pos, double startTime, double duration, double distance, double spin, double angle, NXOpen::Direction *dir)
	Inserts a step. More...
std::vector< int >	MirrorSteps (const std::vector< int > &steps, double mirrorTime)
	Mirrors the steps. More...
NXOpen::SelectNXObjectList *	MotionObject ()
	Returns the object to animated explode. More...
NXString	Name ()
	Returns the name. More...
void	SetColor (NXOpen::NXColor *color)
	Sets the color. More...
void	SetColorOption (NXOpen::AnimationDesigner::AnimatedExplodeBuilder::ColorOptions colorOption)
	Sets the color option. More...
void	SetCreationType (NXOpen::AnimationDesigner::AnimatedExplodeBuilder::CreationTypes creationType)
	Sets the creation type. More...
void	SetName (const NXString &name)
	Sets the name. More...
void	SetName (const char *name)
	Sets the name. More...
void	SetStepAngle (int pos, double angle)
	Sets the step angle. More...
void	SetStepDirection (int pos, NXOpen::Direction *dir)
	Sets the step direction. More...
void	SetStepDistance (int pos, double distance)
	Sets the step distance. More...
void	SetStepDuration (int pos, double duration)
	Sets the step duration. More...
void	SetStepName (int pos, const NXString &name)
	Sets the step name. More...
void	SetStepName (int pos, const char *name)
	Sets the step name. More...
void	SetStepSpin (int pos, double spin)
	Sets the step spin. More...
void	SetStepStartTime (int pos, double startTime)
	Sets the step start time. More...
bool	SplitStep (int pos, double splitTime)
	Splits the step with the split time. 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::AnimationDesigner::AnimatedExplodeBuilder .

To create a new instance of this class, use NXOpen::AnimationDesigner::AnimatedExplodeCollection::CreateAnimatedExplodeBuilder

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::AnimationDesigner::AnimatedExplodeBuilder::ColorOptions

the color options.

Enumerator
ColorOptionsSpecifyColor	Assigns a color to the animated explode.
ColorOptionsAutomaticColor	Auto-assigns a color to each animated explode.
ColorOptionsNoColor	Assigns no color to the animated explode.

enum NXOpen::AnimationDesigner::AnimatedExplodeBuilder::CreationTypes

the creation types.

Enumerator
CreationTypesCombine	Combine all motion objects into one animated explode.
CreationTypesSeparate	Create an animated explode for each motion object.

Member Function Documentation

NXOpen::NXColor* NXOpen::AnimationDesigner::AnimatedExplodeBuilder::Color

(

)

Returns the color.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::AnimationDesigner::AnimatedExplodeBuilder::ColorOptions NXOpen::AnimationDesigner::AnimatedExplodeBuilder::ColorOption

(

)

Returns the color option.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::AnimationDesigner::AnimatedExplodeBuilder::CreationTypes NXOpen::AnimationDesigner::AnimatedExplodeBuilder::CreationType

(

)

Returns the creation type.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::DeleteStep

(

int

pos

)

Deletes the step.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

pos

pos

int NXOpen::AnimationDesigner::AnimatedExplodeBuilder::GetStepCount

(

)

Gets the step count.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::InsertStep	(	int	pos,
		double	startTime,
		double	duration,
		double	distance,
		double	spin,
		double	angle,
		NXOpen::Direction *	dir
	)

Inserts a step.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

pos	pos
startTime	starttime
duration	duration
distance	distance
spin	spin
angle	angle
dir	dir

std::vector<int> NXOpen::AnimationDesigner::AnimatedExplodeBuilder::MirrorSteps	(	const std::vector< int > &	steps,
		double	mirrorTime
	)

Mirrors the steps.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

steps	steps
mirrorTime	mirror time

NXOpen::SelectNXObjectList* NXOpen::AnimationDesigner::AnimatedExplodeBuilder::MotionObject

(

)

Returns the object to animated explode.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXString NXOpen::AnimationDesigner::AnimatedExplodeBuilder::Name

(

)

Returns the name.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::SetColor

(

NXOpen::NXColor *

color

)

Sets the color.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

color

color

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::SetColorOption

(

NXOpen::AnimationDesigner::AnimatedExplodeBuilder::ColorOptions

colorOption

)

Sets the color option.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

colorOption

coloroption

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::SetCreationType

(

NXOpen::AnimationDesigner::AnimatedExplodeBuilder::CreationTypes

creationType

)

Sets the creation type.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

creationType

creationtype

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::SetName

(

const NXString &

name

)

Sets the name.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

name

name

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::SetName

(

const char *

name

)

Sets the name.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

name

name

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::SetStepAngle	(	int	pos,
		double	angle
	)

Sets the step angle.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

pos	pos
angle	angle

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::SetStepDirection	(	int	pos,
		NXOpen::Direction *	dir
	)

Sets the step direction.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

pos	pos
dir	dir

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::SetStepDistance	(	int	pos,
		double	distance
	)

Sets the step distance.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

pos	pos
distance	distance

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::SetStepDuration	(	int	pos,
		double	duration
	)

Sets the step duration.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

pos	pos
duration	duration

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::SetStepName	(	int	pos,
		const NXString &	name
	)

Sets the step name.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

pos	pos
name	name

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::SetStepName	(	int	pos,
		const char *	name
	)

Sets the step name.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

pos	pos
name	name

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::SetStepSpin	(	int	pos,
		double	spin
	)

Sets the step spin.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

pos	pos
spin	spin

void NXOpen::AnimationDesigner::AnimatedExplodeBuilder::SetStepStartTime	(	int	pos,
		double	startTime
	)

Sets the step start time.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

pos	pos
startTime	start time

bool NXOpen::AnimationDesigner::AnimatedExplodeBuilder::SplitStep	(	int	pos,
		double	splitTime
	)

Splits the step with the split time.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

pos	pos
splitTime	split time

---

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

• AnimationDesigner_AnimatedExplodeBuilder.hxx