NXOpen::GeometricUtilities::PlayButtonsBuilder Class Reference

VCR buttons for any dialog that needs them
Created in NX11.0.0. More...

Inheritance diagram for NXOpen::GeometricUtilities::PlayButtonsBuilder:

Public Types
enum	PlayModeValues { PlayModeValuesPlayOnce, PlayModeValuesLoopOver, PlayModeValuesRetrace }
	the different play modes available More...

Public Member Functions
int	CurrentStep ()
	Returns the step Created in NX11.0.0. More...
void	ForwardToEnd ()
	TODO: fill in a description for this Created in NX11.0.0. More...
void	PlayBackward ()
	TODO: fill in a description for this Created in NX11.0.0. More...
void	PlayForward ()
	TODO: fill in a description for this Created in NX11.0.0. More...
NXOpen::GeometricUtilities::PlayButtonsBuilder::PlayModeValues	PlayModes ()
	Returns the play modes Created in NX11.0.0. More...
void	RewindToStart ()
	TODO: fill in a description for this Created in NX11.0.0. More...
double	ScaleSpeed ()
	Returns the scale speed Created in NX11.0.0. More...
double	ScaleStep ()
	Returns the scale step Created in NX11.0.0. More...
void	SetCurrentStep (int currentStep)
	Sets the step Created in NX11.0.0. More...
void	SetPlayModes (NXOpen::GeometricUtilities::PlayButtonsBuilder::PlayModeValues playModes)
	Sets the play modes Created in NX11.0.0. More...
void	SetScaleSpeed (double scaleSpeed)
	Sets the scale speed Created in NX11.0.0. More...
void	SetScaleStep (double scaleStep)
	Sets the scale step Created in NX11.0.0. More...
void	SetSpeed (double speed)
	Sets the speed Created in NX11.0.0. More...
double	Speed ()
	Returns the speed Created in NX11.0.0. More...
void	StepBackward ()
	TODO: fill in a description for this Created in NX11.0.0. More...
void	StepForward ()
	TODO: fill in a description for this Created in NX11.0.0. More...
void	Stop ()
	TODO: fill in a description for this Created in NX11.0.0. 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

VCR buttons for any dialog that needs them
Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::GeometricUtilities::PlayButtonsBuilder::PlayModeValues

the different play modes available

Enumerator
PlayModeValuesPlayOnce	play once
PlayModeValuesLoopOver	loop over
PlayModeValuesRetrace	retrace

Member Function Documentation

int NXOpen::GeometricUtilities::PlayButtonsBuilder::CurrentStep

(

)

Returns the step
Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricUtilities::PlayButtonsBuilder::ForwardToEnd

(

)

TODO: fill in a description for this
Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricUtilities::PlayButtonsBuilder::PlayBackward

(

)

TODO: fill in a description for this
Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricUtilities::PlayButtonsBuilder::PlayForward

(

)

TODO: fill in a description for this
Created in NX11.0.0.

License requirements : None

NXOpen::GeometricUtilities::PlayButtonsBuilder::PlayModeValues NXOpen::GeometricUtilities::PlayButtonsBuilder::PlayModes

(

)

Returns the play modes
Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricUtilities::PlayButtonsBuilder::RewindToStart

(

)

TODO: fill in a description for this
Created in NX11.0.0.

License requirements : None

double NXOpen::GeometricUtilities::PlayButtonsBuilder::ScaleSpeed

(

)

Returns the scale speed
Created in NX11.0.0.

License requirements : None

double NXOpen::GeometricUtilities::PlayButtonsBuilder::ScaleStep

(

)

Returns the scale step
Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricUtilities::PlayButtonsBuilder::SetCurrentStep

(

int

currentStep

)

Sets the step
Created in NX11.0.0.

License requirements : None

Parameters

currentStep

currentstep

void NXOpen::GeometricUtilities::PlayButtonsBuilder::SetPlayModes

(

NXOpen::GeometricUtilities::PlayButtonsBuilder::PlayModeValues

playModes

)

Sets the play modes
Created in NX11.0.0.

License requirements : None

Parameters

playModes

playmodes

void NXOpen::GeometricUtilities::PlayButtonsBuilder::SetScaleSpeed

(

double

scaleSpeed

)

Sets the scale speed
Created in NX11.0.0.

License requirements : None

Parameters

scaleSpeed

scalespeed

void NXOpen::GeometricUtilities::PlayButtonsBuilder::SetScaleStep

(

double

scaleStep

)

Sets the scale step
Created in NX11.0.0.

License requirements : None

Parameters

scaleStep

scalestep

void NXOpen::GeometricUtilities::PlayButtonsBuilder::SetSpeed

(

double

speed

)

Sets the speed
Created in NX11.0.0.

License requirements : None

Parameters

speed

speed

double NXOpen::GeometricUtilities::PlayButtonsBuilder::Speed

(

)

Returns the speed
Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricUtilities::PlayButtonsBuilder::StepBackward

(

)

TODO: fill in a description for this
Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricUtilities::PlayButtonsBuilder::StepForward

(

)

TODO: fill in a description for this
Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricUtilities::PlayButtonsBuilder::Stop

(

)

TODO: fill in a description for this
Created in NX11.0.0.

License requirements : None

virtual bool NXOpen::GeometricUtilities::PlayButtonsBuilder::Validate ( )

virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

---

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

• GeometricUtilities_PlayButtonsBuilder.hxx