2.14. Parameter

2.14.1. Synopsis

2.14.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.14.1.2. Virtual functions

• def isNull ()

2.14.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.14.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 splittable parameters.

Raise

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

Raise

RuntimeError - if a non-default view is specified for a non-splittable parameter

Raise

RuntimeError - if a non-default time is specified for a non-keyframed parameter

Returns the parameter value at the given time and view if they are specified. If time is not specified for a keyframed parameter, returns the parameter’s static value for the 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 splittable parameters.

Raise

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

Raise

RuntimeError - if a non-default view is specified for a non-splittable parameter

Raise

RuntimeError - if a non-default time is specified for a non-keyframed parameter

Sets the parameter value at the given time and view if they are specified. If time is not specified for a keyframed parameter, the static value is changed for the 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.