2.12. Parameter

2.12.1. Synopsis

2.12.1.1. Functions

• def __eq__ (rhs)

• def __ne__ (rhs)

• def get ([time=double( UINT_MAX )[, view=View( 0 )]])

• def get_full_path ()

• def get_keyframes ()

• def get_value ()

• def set (val[, time=double( UINT_MAX )[, view=View( 0 )]])

• def set_keyframes (keyframes)

• def set_keyframes (keyframes)

• def set_value (value)

2.12.1.2. Virtual functions

• def isNull ()

2.12.1.3. Properties

• property full_path [read-only] of list of str

• property keyframes [read-write] of Keyframes

• property value [read-write] of object

2.12.2. Detailed Description

Parameter instance associated with some data object of the project.

class mocha.project.Parameter

Parameter.get([time=double( UINT_MAX )[, view=View( 0 )]])

Return type

object

Parameters

• time (double) – time value for keyframed parameters.

• view (View) – view value for non-keyframed and keyframed parameters.

Raise

AssertionError - if parameter with given name components does not exist.

Returns a value of the parameter by given time and view if they are specified. For static parameters no need to specify time and view. They are ignored in this case. If time is not specified for keyframed parameter - it will return static value for the parameter for given view.

Parameter.get_full_path()

Return type

list of strings

Parameter.get_keyframes()

Return type

Keyframes

Parameter.get_value()

Return type

object

Parameter.isNull()

Return type

bool

Parameter.__ne__(rhs)

Return type

bool

Parameter.__eq__(rhs)

Return type

bool

Parameter.set(val[, time=double( UINT_MAX )[, view=View( 0 )]])

Parameters

• val (object) – new value.

• time (double) – time value for keyframed parameters.

• view (View) – view value for non-keyframed and keyframed parameters.

Raise

AssertionError - if parameter with given name components does not exist.

Sets a value of the parameter by given time and view if they are specified. For static parameters no need to specify time and view. They are ignored in this case. If time is not specified for keyframed parameter - it will change static value for the parameter for given view.

Parameter.set_keyframes(keyframes)

Parameter.set_keyframes(keyframes)

Parameter.set_value(value)

Parameter.full_path

Type

list of str

Access

read-only Provides access to the full parameter name list.

Parameter.value

Type

object

Access

read-write Provides access to the parameter’s static value.

Parameter.keyframes

Type

Keyframes

Access

read-write Provides access to list of the parameter keyframes.