VectorObject

class VectorObject

Bases: ViewerSceneObject, GeometryObject

Viewer scene object for displaying COMPAS Vector geometry.

Parameters:

vectorcompas.geometry.Vector

The vector geometry.

anchorcompas.geometry.Point, optional

The anchor point of the vector. Default is the origin point.

**kwargsdict, optional

Additional options for the compas_viewer.scene.ViewerSceneObject.

See also

compas.geometry.Vector

Notes

The frame object is always unselectable. Apart from the compas_viewer.scene.vectorobject.VectorObject.config.linewidth that controls the width of the vector, the compas_viewer.scene.vectorobject.VectorObject.config.vectorsize (float 0-1) controls the size of the arrow.

Methods

init	Initialize the object

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.
draw	The main drawing method.
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.
update	Update the object.
validate_data	Validate the data against the object's data schema.