2.10. Parameter

2.10.1. Synopsis

2.10.1.1. Functions

2.10.1.2. Virtual functions

2.10.1.3. Properties

2.10.2. Detailed Description

Parameter instance associated with some data object of the project.
class mocha.project.Parameter(Parameter)
Parameter.delete_keyframe(time, view)
Parameters:
  • time (PySide.QtCore.double) – time value for keyframed parameters.
  • view (mocha.project.View) – view value for non-keyframed and keyframed parameters.

Drops keyframe for given time and view.

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

object

Parameters:
  • time (PySide.QtCore.double) – time value for keyframed parameters.
  • view (mocha.project.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_keyframes()
Return type:list of QPairView,double
Parameter.get_name_components()
Return type:list of strings
Parameter.isNull()
Return type:PySide.QtCore.bool
Parameter.__ne__(rhs)
Return type:PySide.QtCore.bool
Parameter.__eq__(rhs)
Return type:PySide.QtCore.bool
Parameter.set(val[, time=double( UINT_MAX )[, view=View( 0 )]])
Parameter.name_components
Type:list of str
Access:read-only

Provides access to the full parameter name list.

Parameter.keyframes
Type:list of 2-value tuples
Access:read-only

Provides access to list of the parameter keyframes.