GeomEntity

The base class for specifically the Geometry types (Body, Surface, etc.).

Inheritance

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

Class Member Functions

  mesh Mesh the GeomEntity.
Bool is_meshed Return the current mesh state of the GeomEntity.
  smooth Smooths the mesh on the GeomEntity.
  remove_mesh Removes the mesh on the GeomEntity.
str entity_name Return the first name of the GeomEntity.
  entity_name Assign a name to the GeomEntity.
[ str ] entity_names Return the all the names of the GeomEntity.
int num_names Return the number of names for the GeomEntity.
  remove_entity_name Remove a specific name from the list of names assigned to the GeomEntity.
  remove_entity_names Remove all the names assigned to the GeomEntity.
int dimension Get the dimensions of the GeomEntity.
[ Body] bodies Get the bodies in the GeomEntity.
[ Volume] volumes Get the volumes in the GeomEntity.
[ Surface] surfaces Get the surfaces in the GeomEntity.
[ Curve] curves Get the curves in the GeomEntity.
[ Vertex] vertices Get the vertices in the GeomEntity.

Member Function Documentation

mesh()

Mesh the GeomEntity.

Example

 geomEntity.mesh()

Bool is_meshed()

Return the current mesh state of the GeomEntity.

Example

 mesh = geomEntity.is_meshed()

Return

Whether the GeomEntityis meshed or not

smooth()

Smooths the mesh on the GeomEntity.

Example

 geomEntity.smooth()

remove_mesh()

Removes the mesh on the GeomEntity.

Example

 geomEntity.remove_mesh()

str entity_name()

Return the first name of the GeomEntity.

Example

 name = geomEntity.entity_name()

Return

The first name of the GeomEntity

entity_name(name)

Assign a name to the GeomEntity.

Example

 geomEntity.entity_name("Brick1")

Parameters

name The name to be assigned to the GeomEntity

[ str ] entity_names()

Return the all the names of the GeomEntity.

Example

 names = geomEntity.entity_names()

Return

A vector (or list) of all the names of the GeomEntity

int num_names()

Return the number of names for the GeomEntity.

Example

 num = geomEntity.num_names()

Return

The number of names for the GeomEntity

remove_entity_name(name)

Remove a specific name from the list of names assigned to the GeomEntity.

Example

 geomEntity.remove_entity_name("Brick1")

Parameters

name The name to be removed from the list of names assigned to the GeomEntity

remove_entity_names()

Remove all the names assigned to the GeomEntity.

Example

 geomEntity.remove_entity_names()

int dimension()

Get the dimensions of the GeomEntity.

Example

 dim = geomEntity.dimension()

Return

The dimension of the GeomEntity

[ Body] bodies()

Get the bodies in the GeomEntity.

Example

 bodies = geomEntity.bodies()

Return

A vector (or list) of bodies contained within the GeomEntity

[ Volume] volumes()

Get the volumes in the GeomEntity.

Example

 volumes = geomEntity.volumes()

Return

A vector (or list) of volumes contained within the GeomEntity

[ Surface] surfaces()

Get the surfaces in the GeomEntity.

Example

 surfaces = geomEntity.surfaces()

Return

A vector (or list) of surfaces contained within the GeomEntity

[ Curve] curves()

Get the curves in the GeomEntity.

Example

 curves = geomEntity.curves()

Return

A vector (or list) of curves contained within the GeomEntity

[ Vertex] vertices()

Get the vertices in the GeomEntity.

Example

 vertices = geomEntity.vertices()

Return

A vector (or list) of vertices contained within the GeomEntity