FrameObject

class compas_ghpython.scene.FrameObject

Bases: GHSceneObject, GeometryObject

Scene object for drawing frames.

Parameters:

framecompas.geometry.Frame

A COMPAS frame.

scalefloat, optional

The scale of the vectors representing the axes of the frame.

**kwargsdict, optional

Additional keyword arguments.

Attributes:

scalefloat

Scale factor that controls the length of the axes.

color_origincompas.colors.Color

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.
clear	The main clearing method.
copy	Make an independent copy of the data object.
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.
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.
validate_data	Validate the data against the object's data schema.