BoundingVolume
-
class
compas_fab.robots.
BoundingVolume
(volume_type, volume)[source] Bases:
object
A container for describing a bounding volume.
- Parameters
volume_type – The type of bounding volume, one of
BoundingVolume.VOLUME_TYPES
.volume (
compas.datastructures.Mesh
orcompas.geometry.Primitive
) – The volume can be either acompas.geometry.Box
, acompas.geometry.Sphere
, or acompas.datastructures.Mesh
.
- Attributes
volume_type – The type of bounding volume, one of
BoundingVolume.VOLUME_TYPES
.volume (
compas.datastructures.Mesh
orcompas.geometry.Primitive
) – The volume can be either acompas.geometry.Box
, acompas.geometry.Sphere
, or acompas.datastructures.Mesh
.
- Class Attributes
BOX – Box bounding volume type.
SPHERE – Sphere bounding volume type.
MESH – Mesh bounding volume type.
VOLUME_TYPES – List of supported bounding volume types.
Methods
__init__
(volume_type, volume)Initialize self.
copy
()Make a copy of this
BoundingVolume
.from_box
(box)Create a
BoundingVolume
from acompas.geometry.Box
.from_mesh
(mesh)Create a
BoundingVolume
from acompas.datastructures.Mesh
.from_sphere
(sphere)Create a
BoundingVolume
from acompas.geometry.Sphere
.scale
(scale_factor)Scale the volume uniformly.
transform
(transformation)Transform the volume using a
compas.geometry.Transformation
.Attributes
BOX
Box bounding volume type
MESH
Mesh bounding volume type
SPHERE
Sphere bounding volume type
VOLUME_TYPES
List of supported volume types