NXOpen::AnimationDesigner::AnimatedVisibilityBuilder Class Reference

Represents a NXOpen::AnimationDesigner::AnimatedVisibilityBuilder . More...

Inheritance diagram for NXOpen::AnimationDesigner::AnimatedVisibilityBuilder:

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::AnimatedVisibilityBuilder::ColorOptions	ColorOption ()
	Returns the color option. More...
void	CreateBar (int index)
	Creates a new bar. More...
NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::CreationTypes	CreationType ()
	Returns the creation type. More...
void	DeleteBars (const std::vector< int > &bars)
	Deletes the bars. More...
void	MirrorBars (const std::vector< int > &bars, double mirrorTime)
	Mirrors the bars. More...
NXString	Name ()
	Returns the name. More...
NXOpen::SelectNXObjectList *	RigidGroup ()
	Returns the rigid group to display translucency. More...
void	SetBarEndTime (int index, double endTime)
	Sets the bar end time. More...
void	SetBarEndTranslucency (int index, int translucency)
	Sets the bar end translucency. More...
void	SetBarName (int index, const NXString &name)
	Sets the bar name. More...
void	SetBarName (int index, const char *name)
	Sets the bar name. More...
void	SetBarStartTime (int index, double startTime)
	Sets the bar start time. More...
void	SetBarStartTranslucency (int index, int translucency)
	Sets the bar start translucency. More...
void	SetColor (NXOpen::NXColor *color)
	Sets the color. More...
void	SetColorOption (NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::ColorOptions colorOption)
	Sets the color option. More...
void	SetCreationType (NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::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	SetTranslucency (int translucency)
	Sets the translucency. More...
void	SplitBar (int index, double splitTime)
	Splits the bar with the split time. More...
int	Translucency ()
	Returns the translucency. 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::AnimatedVisibilityBuilder .

To create a new instance of this class, use NXOpen::AnimationDesigner::AnimatedVisibilityCollection::CreateAnimatedVisibilityBuilder

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::ColorOptions

the color options.

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

enum NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::CreationTypes

the creation types.

Enumerator
CreationTypesCombine	Combine selections into one animated visibility.
CreationTypesSeparate	Create an animated visibility for each selection.

Member Function Documentation

NXOpen::NXColor* NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::Color

(

)

Returns the color.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::ColorOptions NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::ColorOption

(

)

Returns the color option.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

void NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::CreateBar

(

int

index

)

Creates a new bar.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

index

index

NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::CreationTypes NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::CreationType

(

)

Returns the creation type.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

void NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::DeleteBars

(

const std::vector< int > &

bars

)

Deletes the bars.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

bars

bars

void NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::MirrorBars	(	const std::vector< int > &	bars,
		double	mirrorTime
	)

Mirrors the bars.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

bars	bars
mirrorTime	mirror time

NXString NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::Name

(

)

Returns the name.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::SelectNXObjectList* NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::RigidGroup

(

)

Returns the rigid group to display translucency.

This can be a NXOpen::AnimationDesigner::RigidGroup .
Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

void NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::SetBarEndTime	(	int	index,
		double	endTime
	)

Sets the bar end time.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

index	index
endTime	end time

void NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::SetBarEndTranslucency	(	int	index,
		int	translucency
	)

Sets the bar end translucency.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

index	index
translucency	translucency

void NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::SetBarName	(	int	index,
		const NXString &	name
	)

Sets the bar name.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

index	index
name	name

void NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::SetBarName	(	int	index,
		const char *	name
	)

Sets the bar name.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

index	index
name	name

void NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::SetBarStartTime	(	int	index,
		double	startTime
	)

Sets the bar start time.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

index	index
startTime	start time

void NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::SetBarStartTranslucency	(	int	index,
		int	translucency
	)

Sets the bar start translucency.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

index	index
translucency	translucency

void NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::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::AnimatedVisibilityBuilder::SetColorOption

(

NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::ColorOptions

colorOption

)

Sets the color option.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

colorOption

coloroption

void NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::SetCreationType

(

NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::CreationTypes

creationType

)

Sets the creation type.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

creationType

creationtype

void NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::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::AnimatedVisibilityBuilder::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::AnimatedVisibilityBuilder::SetTranslucency

(

int

translucency

)

Sets the translucency.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

translucency

translucency

void NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::SplitBar	(	int	index,
		double	splitTime
	)

Splits the bar with the split time.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters

index	index
splitTime	split time

int NXOpen::AnimationDesigner::AnimatedVisibilityBuilder::Translucency

(

)

Returns the translucency.

Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

---

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

• AnimationDesigner_AnimatedVisibilityBuilder.hxx