CriAtomExTween Class Reference

AtomExTween Class More...

Inherits CriDisposable.

Public Types
enum	ParameterType : System.Int32 { Basic, Aisac }
	Type of Tween parameter More...

Public Member Functions
	CriAtomExTween ()
	Creates an AtomExTween More...
	CriAtomExTween (CriAtomEx.Parameter parameterId)
	Creates an AtomExTween (control of basic parameters) More...
	CriAtomExTween (uint aisacId)
	Creates an AtomExTween (AISAC control) More...
override void	Dispose ()
	Destroys the AtomExTween More...
void	MoveTo (ushort durationMs, float value)
	Changes the parameter from the current value to the specified one More...
void	MoveFrom (ushort durationMs, float value)
	Changes the parameter from the specified value to the current one More...
void	Stop ()
	Stops the AtomExTween More...
void	Reset ()
	Resets the AtomExTween More...

Properties
float	Value [get]
	Gets the current values of the parameters of AtomExTween More...
bool	IsActive [get]
	Gets whether it is changing currently More...

Detailed Description

AtomExTween Class

Description:

Runs the animation of the parameters by attaching to the player.

See also

CriAtomExPlayer.AttachTween(CriAtomExTween), CriAtomExPlayer.DetachTween(CriAtomExTween), CriAtomExPlayer.DetachTweenAll

Member Enumeration Documentation

enum ParameterType : System.Int32

strong

Type of Tween parameter

Enumerator
Basic	Manipulation of basic parameters such as volume and pitch See also CriAtomEx.Parameter
Aisac	Manipulating the AISAC control value

Constructor & Destructor Documentation

CriAtomExTween ( )

inline

Creates an AtomExTween

Returns

AtomExTween Object

Note:

The AtomExTween created by this constructor operates on the volume.

CriAtomExTween ( CriAtomEx.Parameter  parameterId )

inline

Creates an AtomExTween (control of basic parameters)

Returns

AtomExTween Object

Parameters

parameterId

Parameter ID

See also

CriAtomEx.Parameter

CriAtomExTween ( uint  aisacId )

inline

Creates an AtomExTween (AISAC control)

Returns

AtomExTween Object

Parameters

aisacId

AISAC control ID

Member Function Documentation

override void Dispose ( )

inline

Destroys the AtomExTween

Note:

A reference to the destroyed AtomExTween will occur if this function is excuted
while the AtomExPlayer with the AtomExTween attached is playing audio.
Be sure to execute this function after detaching from the AtomExPlayer.

void MoveTo ( ushort  durationMs, float  value  )

inline

Changes the parameter from the current value to the specified one

Description:

Changes the parameter from the current value when called to the specified value over the specified time.
The change curve type is linear.

Parameters

durationMs	Time required for the change (milliseconds)
value	The final value after the change

void MoveFrom ( ushort  durationMs, float  value  )

inline

Changes the parameter from the specified value to the current one

Description:

Changes the parameter from the specified value to the current value when called over the specified time.
The change curve type is linear.

Parameters

durationMs	Time required for the change (milliseconds)
value	The initial value before the change

void Stop ( )

inline

Stops the AtomExTween

Description:

Stops the time change of parameters caused by AtomExTween.
The value of the parameter will be its value when stopped.

void Reset ( )

inline

Resets the AtomExTween

Description:

Stops the AtomExTween and resets the parameters to their initial values. For basic parameters: Initial value of each parameter
For AISAC control values: 0.0

Property Documentation

float Value

get

Gets the current values of the parameters of AtomExTween

Returns

The current value of the parameter

bool IsActive

get

Gets whether it is changing currently

Returns

Whether the parameter is changing

---

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

• CriAtomExTween.cs