Box

class compas.robots.Box(size)[source]

Bases: compas.robots.model.geometry.BaseShape

3D shape primitive representing a box.

Parameters

size (str) – The dimensions of the box in x-, y-, and z-axis, like ‘1 1 1’.

Attributes

size (list of 3 float) – The dimensions of the box.
geometry (compas.geometry.Box) – The COMPAS geometry of this box.

Examples

>>> box = Box('1 1 1')
>>> box.geometry
Box(Frame(Point(0.000, 0.000, 0.000), Vector(1.000, 0.000, 0.000), Vector(0.000, 1.000, 0.000)), 1.0, 1.0, 1.0)

Attributes

data

The representation of the object as native Python data.

Inherited Attributes

`DATASCHEMA`	The schema of the data of this object.
`JSONSCHEMA`	The schema of the JSON representation of the data of this object.
`JSONSCHEMANAME`
`dtype`	The type of the object in the form of a '2-level' import and a class name.
`guid`	The globally unique identifier of the object.
`jsondefinitions`	Reusable schema definitions.
`jsonstring`	The representation of the object data in JSON format.
`jsonvalidator`	JSON schema validator for draft 7.
`name`	The name of the object.

Methods

`from_data`	Construct an object of this type from the provided data.
`from_geometry`
`get_urdf_element`

Inherited Methods

`copy`	Make an independent copy of the data object.
`from_json`	Construct an object from serialized data contained in a JSON file.
`from_jsonstring`	Construct an object from serialized data contained in a JSON string.
`to_data`	Convert an object to its native data representation.
`to_json`	Serialize the data representation of an object to a JSON file.
`to_jsonstring`	Serialize the data representation of an object to a JSON string.
`validate_data`	Validate the object's data against its data schema (self.DATASCHEMA).
`validate_json`	Validate the object's data against its json schema (self.JSONSCHEMA).

Box

COMPAS