FrameObject

class FrameObject

Bases: ViewerSceneObject

The scene object of the COMPAS Frame. With its modifiable cell size and dimension.

Parameters:

framecompas.geometry.Frame

The frame geometry.

framesizetuple[float, int, float, int]

The size of the grid in [dx, nx, dy, ny] format. Notice that the nx and ny must be even numbers.

linecolorcompas.colors.Color

The color of the grid lines.

show_framezbool

If True, the Z axis of the grid will be shown.

Attributes:

framecompas.geometry.Frame

The frame geometry.

dxfloat

The size of the grid in the X direction.

nxint

The number of grid cells in the X direction.

dyfloat

The size of the grid in the Y direction.

nyint

The number of grid cells in the Y direction.

show_framezbool

If the Z axis of the grid is shown.

See also

compas.geometry.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.
draw	Draw the object from its buffers
draw_instance	Draw the object instance for picking
from_json	Construct an object of this type from a JSON file.
from_jsonstring	Construct an object of this type from a JSON string.
init	Initialize the object
make_buffer_from_data	Create buffers from point/line/face data.
make_buffers	Create all buffers from object's data
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.
update_buffer_from_data	Update existing buffers from point/line/face data.
validate_data	Validate the data against the object's data schema.