threedb.controls.blender.orientation¶
Cover the subject object with another object. An example config file using this control can be found here: https://github.com/3db/3db/tree/main/examples/unit_tests/orientation.yaml.
-
class
threedb.controls.blender.orientation.
OrientationControl
(root_folder: str)¶ Bases:
threedb.controls.base_control.PreProcessControl
This control changes the orientation of the object (i.e. the rotation).
Continuous Parameters:
rotation_x
: The x component of the Eulerian rotation (default range:[-pi, pi]
)rotation_y
: The y component of the Eulerian rotation (default range:[-pi, pi]
)rotation_z
: The z component of the Eulerian rotation (default range:[-pi, pi]
)
-
__init__
(root_folder: str)¶ Construct a BaseControl
- Parameters
root_folder – The folder containing all the data for this 3DB experiment. All paths are lative to his folder
-
apply
(context: Dict[str, Any], control_args: Dict[str, Any]) → None¶ Rotates the object according to the given parameters
- Parameters
context (Dict[str, Any]) – The scene context object
control_args (Dict[str, Any]) – The parameters for this control,
rotation_x
,rotation_y
, androtation_z
. See the class docstring for their documentation.
-
unapply
(context: Dict[str, Any]) → None¶ Undo the modification on a scene
Note
Most of the time, recreating a scene is very expensive, therefore, controls are asked to implement a reverse operation to undo their changes. Controls that need to store state in order to undo their actions should add data to the target object they received.
- Parameters
context (Dict[str, Any]) – The description of the scene to render
-
threedb.controls.blender.orientation.
Control
¶ alias of
threedb.controls.blender.orientation.OrientationControl