FrameObject

class FrameObject

Bases: ViewerSceneObject, GeometryObject

The scene object of the COMPAS Frame geometry. With its modifiable cell size and dimension, the world grid is also created from this class.

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.

show_framezbool

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

See also

compas.geometry.Frame

Notes

The frame object is always unselectable.

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.

Methods

draw_edges
draw_faces
draw_vertices

Inherited Methods

add	Add a child item to the scene object.
clear	Clear the object
draw	Draw the object from its buffers
draw_instance	Draw the object instance for picking
init	Initialize the object
make_buffer_from_data	Create buffers from point/line/face data.
make_buffers	Create all buffers from object's data
update	Update the object
update_buffer_from_data	Update existing buffers from point/line/face data.
update_buffers	Update all buffers from object's data