FrameObject

class compas_blender.scene.FrameObject

Bases: BlenderSceneObject, GeometryObject

Scene object for drawing frames in Blender.

Parameters:

frame: :class:`compas.geometry.Frame`

A COMPAS frame.

scalefloat, optional

Scale of the frame axes.

**kwargsdict, optional

Additional keyword arguments. For more info, see compas_blender.scene.BlenderSceneObject and compas.scene.GeometryObject.

Attributes:

color_origincompas.colors.Color

Color for the point at the frame origin. Default is Color.black().

color_xaxiscompas.colors.Color

Default is Color.red().

color_yaxiscompas.colors.Color

Default is Color.green().

color_zaxiscompas.colors.Color

Default is Color.blue().

Methods

draw	Draw the frame.

Inherited Methods

ToString	Converts the instance to a string.
add	Add a child item to the scene object.
add_object_to_collection	Add an object to a collection.
clear	The main clearing method.
clear_collection	Clear the objects in a collection.
copy	Make an independent copy of the data object.
create_collection	Create a collection with the given name.
create_object	Add an object to the Blender scene.
delete_collection	Delete a collection.
from_json	Construct an object of this type from a JSON file.
from_jsonstring	Construct an object of this type from a JSON string.
remove	Remove a child node from this node.
set_object_color	Set the color of a Blender object.
set_object_tranformation	Set the transformation of a Blender object.
sha256	Compute a hash of the data for comparison during version control using the sha256 algorithm.
to_json	Convert an object to its native data representation and save it to a JSON file.
to_jsonstring	Convert an object to its native data representation and save it to a JSON string.
traverse	Traverse the tree from this node.
update_object	Update an object in the Blender scene.
validate_data	Validate the data against the object's data schema.