Entity

The base class of all the geometry and mesh types.

Inheritance

PyObservable
Entity
GeomEntity
Body | Curve | Surface | Vertex | Volume

Class Member Functions

  destroy_cubit_entity  
[ float ] bounding_box Get the bounding box of the Entity.
[ float ] center_point Get the center point of the Entity.
int id Get the id of the Entity.
  is_visible Set the visibility state of the Entity.
int is_visible Get the visibility state of the Entity.
  is_transparent Set the tranparency state of the Entity.
int is_transparent Get the tranparency state of the Entity.

Member Function Documentation

destroy_cubit_entity()

[ float ] bounding_box()

Get the bounding box of the Entity.

Example

 b_box = entity.bounding_box()

Return

The bounding box as a vector (or list) where the indices correspond to the values as follows: 0 - minimum x value 1 - minimum y value 2 - minimum z value 3 - maximum x value 4 - maximum y value 5 - maximum z value

[ float ] center_point()

Get the center point of the Entity.

Example

 center = entity.center_point()

Return

The center point as a vector (or list) where the indices correspond to the values as follows: 0 - x value 1 - y value 2 - z value

int id()

Get the id of the Entity.

Example

 id = entity.id()

Return

The id of the Entity

is_visible(visibility_flag)

Set the visibility state of the Entity.

Example

 entity.is_visible(1)

Parameters

visibility_flag The flag that sets whether the Entityis visible (1) or not (0)

int is_visible()

Get the visibility state of the Entity.

Example

 vis = entity.is_visible()

Return

The current visiblity state of the Entity(1 if visible, 0 if not)

is_transparent(transparency_flag)

Set the tranparency state of the Entity.

Example

 entity.is_transparent(1)

Parameters

transparency_flag The flag that sets whether the Entityis transparent (1) or not (0)

int is_transparent()

Get the tranparency state of the Entity.

Example

 trans = entity.is_transparent()

Return

The current transparency state of the Entity(1 if transparent, 0 if not)