menu::MInterpolator Class Reference

Base interpolator . More...

Inheritance diagram for menu::MInterpolator:

Public Member Functions
Float	getStartDuration (Int index)
void	setStartDuration (Int index, Float duration)
Float	getEndDuration (Int index)
void	setEndDuration (Int index, Float duration)
Float	getInterpolationPeriod (Int index)
void	setInterpolationPeriod (Int index, Float value)
Float	getTension (Int index)
void	setTension (Int index, Float value)
Float	getSlope (Int index)
void	setSlope (Int index, Float value)
Public Member Functions inherited from menu::MActor
	MActor ()
	constructor taking no param More...
void	initialize ()
void	start ()
void	stop ()
void	rewind ()
void	warp ()
void	forward ()
void	backward ()
void	flip ()
void	restart ()
void	reset ()
Public Member Functions inherited from menu::MNode
MNode	doCopy ()
	Makes a copy of this node. More...
String	getNodePath (MNode relative_to=nil, String module_separator=nil)
	Gets this node's path. More...
void	doInitialize (MRenderContext context)
	Initializes this node. More...
void	doFinalize (MRenderContext context)
	Finalizes (destroys) this node. More...
Public Member Functions inherited from System::Module
	Module ()
	constructor taking no param More...
	Module (String name)
	Constructs. More...
Bool	load (String scriptName)
	Loads all modules from the specified script. More...
void	defineModule (Module module)
	Defines a new module within this module. More...
void	defineModule (Object symbol, Module module)
	Defines a new module within this module. More...
void	defineClass (Class class)
	Defines a new class within this module. More...
void	defineClass (Object symbol, Class class)
	Defines a new class within this module. More...
void	defineStatic (String staticName, Object staticValue)
	Defines a new static within this module. More...
void	defineAttribute (String attributeName, Object attributeValue)
	Defines a new attribute within this module. More...
void	import (Module module, Object symbol)
	Imports a module onto this one. More...
void	import (Module module, Object symbol, Object alias)
	Imports a module onto this one with the specified alias. More...
void	removeStatic (String staticName)
	Removes a specific static member from the module by name. More...
void	clearStatic ()
	Clears all static members from the module. More...
void	each_attribute (FunctionObject< Array > func)
	Performs a callback on each attribute in the module. More...
void	map_attribute (FunctionObject< Array > func)
	Creates a new array populated with the results of calling a provided function on every element in the calling array. More...
Array	find_all (FunctionObject func)
	Finds all static members that matches the precondition. More...
Object	find_static (FunctionObject precondition)
	Finds a static member that matches the precondition. More...
String	getModulePath ()
	Gets the module's path name. More...
Object	getModuleAttribute (String path)
void	setModuleAttribute (String path, Object value)
Object	getScopeAttribute (String path)
void	setScopeAttribute (String path, Object value)
Public Member Functions inherited from System::Object
	Object ()
	constructor taking no param More...
Bool	isInstanceOf (Class classType)
	Returns whether an object is of a specific class/type. More...
Object	getDeepCopy ()
	Gets a deep copy of this object. More...
void	setDeepCopy (Object obj)
	Unk. More...
String	dump ()
	Dumps all info about an object. More...
Object	getObjectAttribute (string path)
void	setObjectAttribute (string path, Object value)
Bool	hasPrimitiveInterface ()
	Returns whether this object has a primitive interface. More...
Bool	toBool ()
	Casts this object to Bool. More...
Byte	toByte ()
	Casts this object to Byte. More...
Short	toShort ()
	Casts this object to Short. More...
Int	toInt ()
	Casts this object to Int. More...
Long	toLong ()
	Casts this object to Long. More...
UByte	toUByte ()
	Casts this object to UByte. More...
UShort	toUShort ()
	Casts this object to UShort. More...
UInt	toUInt ()
	Casts this object to UInt. More...
ULong	toULong ()
	Casts this object to ULong. More...
Float	toFloat ()
	Casts this object to Float. More...
Double	toDouble ()
	Casts this object to Double. More...
String	toString ()
	Casts this object to String. More...
Symbol	toSymbol ()
	Casts this object to Symbol. More...
Bool	hasArrayInterface ()
	Returns whether this object has an Array interface. More...
Int	getArrayCount ()
	Gets the Array item count for this object. More...
void	setArrayCount ()
	Sets the Array item count for this object. More...
Object	getArrayElement (Object arg0)
	Gets an Array item for this object. More...
void	setArrayElement (Object arg0, Object arg1)
	Sets the Array item for this object. More...
Bool	hasMapInterface ()
	Returns whether this object has a Map interface. More...
int	getMapCount ()
	Returns the count of items in the map. More...
void	setMapElement (Object arg0, Object arg1)
	Returns whether the Map has a specific object key. Bool hasMapElement(Object arg0);. More...
Object	getMapElement (Object arg0)
	Gets a Map element by key. More...
void	hasGeneratorInterface ()
	Returns whether this object has a generator interface. More...
Iterator	generator ()
	Returns generator (?) More...
void	hasIteratorInterface ()
	Returns whether this object has an iterator. More...
Iterator	iterator ()
	Gets the iterator for this object. More...
void	hasVariableInterface ()
	Returns whether this object is a variable. More...
void	hasFunctionInterface ()
	Returns whether this object has a function interface. More...
Object	call ()
	Calls this object as a function. More...
Bool	hasByteDataInterface ()
	Returns whether this object has a byte data interface. More...
Int	getByteDataCount ()
	Returns the ByteData size for this object. More...
void	setByteDataCount (Int count)
	Sets the ByteData size for this object. More...
Int	getByteDataCapacity ()
	Returns the ByteData capacity for this object. More...
void	setByteDataCapacity (Int capacity)
	Sets the ByteData capacity for this object. More...
ByteData	getByteData ()
	Gets the underlaying ByteData. More...
void	setByteData (ByteData bytedata)
	Sets the underlaying ByteData. More...
void	hasObjectSelectorInterface ()
	Returns whether this object has an object selector interface. More...
void	self ()
	Gets the get for this object if it has a get interface. More...
void	getArchiveTree ()
void	setArchiveTree ()
ByteData	serialize ()
	Serializes this object. More...
void	deserialize (ByteData serializedData)
	Deserializes this object. More...
void	defined (Object obj)
	Returns whether a certain object is defined within this object. More...
Array	find_all (FunctionObject func)
	Finds all the elements in this object that matches the predicates. More...
void	each_all (FunctionObject func)
	Applies callback to all elements in this object. More...
Array	map_all (FunctionObject< Object > func)
	Maps all the elements in this object. More...
Bool	operator!= ()
	Returns whether this object is not equal to another. More...
Bool	operator== ()
	Returns whether this object is equal to another. More...

Public Attributes
String	attribute_name
String	operation_type_name
	Operation type. Defaults to "replace". More...
Int	loop_count
	Loop count. Defaults to 0. More...
Float	start_delay
	Start delay. Defaults to 0.0. More...
Float	end_delay
	End delay. Defaults to 0.0. More...
Bool	use_sync_timer
	Defaults to false. More...
Float	total_time
	Defaults to 0.0. More...
Float	time
Float	ramain_time
Int	section_count
	Defaults to 0. More...
Public Attributes inherited from menu::MActor
MNode	target_node
Bool	initial_playing
	Defaults true. More...
Bool	initial_pause
	Defaults false. More...
Bool	initial_reverse
	Defaults false. More...
String	focus_enter_action_name
	Focus enter action name. Defaults to "keep". More...
String	focus_leave_action_name
	Focus leave action name. Defaults to "keep". More...
MActor	next_actor
	Getter-only. More...
MActor	prev_actor
	Getter-only. More...
Object	on_effect_start
Object	on_effect_end
Object	rt_effect_start
Object	rt_effect_end
Bool	pause
	Whether the actor is paused. More...
Bool	reverse
Bool	out
	Setter-only. More...
Public Attributes inherited from menu::MNode
MNode	parent
	Gets or sets the parent node for this node. More...
MNode	next
	Getter-only. Gets the next node for this node. More...
MNode	prev
	Getter-only. Gets the previous node for this node. More...
MNode	next_node
	Getter-only. Gets the next node for this node. Same as next. More...
MNode	prev_node
	Getter-only. Gets the previous node for this node. Same as prev. More...
String	class_name
	Getter-only. Gets the class name of this node. i.e "MRootWindow". More...
String	prototype_name
	Getter-only. Gets the prototype name of this node. i.e "RootWindow". More...
String	node_name
	Getter-only. Gets the name of this node. i.e "TopRoot". More...
String	node_path
	Getter-only. Gets the path of this node. i.e "RunViewerProject::TopRoot". More...
Bool	has_alias_name
	Getter-only. More...
String	alias_name
	Alias name. Returns "nil" if not set (use has_alias_name) More...
Bool	has_script
	Whether this node is linked to a script. More...
Bool	is_enable
	Whether this node is enabled. More...
Bool	package_ref
MRootWindow	root_window
	Getter-only. Returns the root window linked to this node. More...
MProject	project
	Getter-only. Returns the project linked to this node. More...
Object	reset_script_check
Bool	has_alias
	Getter-only. More...
Bool	is_component
Public Attributes inherited from System::Module
String	name
	Returns the module name. More...
Public Attributes inherited from System::Object
Int	rc_size
	Getter-only. Reference counter size of this object. More...
Object	rc_class
	Getter-only. Type name of the object. More...
Int	rc_count
	Getter-only. Reference count of this object. More...
Int	weak_count
	Getter-only. Weak reference count of this object. More...
Class	class_id
	Class (type) object for this object. More...

Additional Inherited Members
Static Public Attributes inherited from menu::MNode
static String	GT4_compatible_name
	Setter-only. Unknown, sets an engine singleton. May not be used. More...

Detailed Description

Base interpolator .

Definition at line 8 of file MInterpolator.cpp.

Member Function Documentation

getEndDuration()

Float menu::MInterpolator::getEndDuration

(

Int

index

)

getInterpolationPeriod()

Float menu::MInterpolator::getInterpolationPeriod

(

Int

index

)

getSlope()

Float menu::MInterpolator::getSlope

(

Int

index

)

getStartDuration()

Float menu::MInterpolator::getStartDuration

(

Int

index

)

getTension()

Float menu::MInterpolator::getTension

(

Int

index

)

setEndDuration()

void menu::MInterpolator::setEndDuration	(	Int	index,
		Float	duration
	)

setInterpolationPeriod()

void menu::MInterpolator::setInterpolationPeriod	(	Int	index,
		Float	value
	)

setSlope()

void menu::MInterpolator::setSlope	(	Int	index,
		Float	value
	)

setStartDuration()

void menu::MInterpolator::setStartDuration	(	Int	index,
		Float	duration
	)

setTension()

void menu::MInterpolator::setTension	(	Int	index,
		Float	value
	)

Member Data Documentation

attribute_name

String menu::MInterpolator::attribute_name

Definition at line 11 of file MInterpolator.cpp.

end_delay

Float menu::MInterpolator::end_delay

End delay. Defaults to 0.0.

Definition at line 27 of file MInterpolator.cpp.

loop_count

Int menu::MInterpolator::loop_count

Loop count. Defaults to 0.

Definition at line 21 of file MInterpolator.cpp.

operation_type_name

String menu::MInterpolator::operation_type_name

Operation type. Defaults to "replace".

Available options:

• "replace"
• "add"
• "multiply"

Definition at line 18 of file MInterpolator.cpp.

ramain_time

Float menu::MInterpolator::ramain_time

Definition at line 36 of file MInterpolator.cpp.

section_count

Int menu::MInterpolator::section_count

Defaults to 0.

Definition at line 39 of file MInterpolator.cpp.

start_delay

Float menu::MInterpolator::start_delay

Start delay. Defaults to 0.0.

Definition at line 24 of file MInterpolator.cpp.

time

Float menu::MInterpolator::time

Definition at line 35 of file MInterpolator.cpp.

total_time

Float menu::MInterpolator::total_time

Defaults to 0.0.

Definition at line 33 of file MInterpolator.cpp.

use_sync_timer

Bool menu::MInterpolator::use_sync_timer

Defaults to false.

Definition at line 30 of file MInterpolator.cpp.

---

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

• headers/menu/Interpolators/MInterpolator.cpp