Coreform Cubit 2024.3 User Documentation
Click here to see this page in full context

Coreform Cubit 2024.3 User Documentation

Cubit Python API 2024.3
Public Member Functions | Protected Attributes
Entity

The base class of all the geometry and mesh types. More...

#include <CubitInterfaceEx.hpp>

Inheritance diagram for Entity:
GeomEntity Body Curve Surface Vertex Volume

Public Member Functions
  Entity ()
 
  Entity (CubitEntity *entity_ptr)
 
  Entity (Entity const &copy_from)
 
  ~Entity ()
 
std::array< double, 6 > bounding_box ()
  Get the bounding box of the Entity.
 
std::array< double, 3 > center_point ()
  Get the center point of the Entity.
 
void destroy_cubit_entity ()
 
CubitEntity * entity_ptr ()
 
int id ()
  Get the id of the Entity.
 
int is_transparent ()
  Get the tranparency state of the Entity.
 
void is_transparent (int transparency_flag)
  Set the tranparency state of the Entity.
 
int is_visible ()
  Get the visibility state of the Entity.
 
void is_visible (bool visibility_flag)
  Set the visibility state of the Entity.
 
Entity & operator= (const Entity &rhs)
 
void set_transparent (int transparency_flag)
  Set the tranparency state of the Entity.
 
void set_visible (bool visibility_flag)
  Set the visibility state of the Entity.
 

Protected Attributes
CubObserver * CubitWatcher
 
CubitEntity * mEntityPtr
 

Detailed Description

The base class of all the geometry and mesh types.

import cubit
 
br = cubit.brick(1,1,1)
cubit.scale(br,2)
cubit.cmd('delete body 1' )

Constructor & Destructor Documentation

◆ ~Entity()

~Entity (   )  
 

◆ Entity() [1/3]

Entity (   )  
 

◆ Entity() [2/3]

Entity ( CubitEntity * entity_ptr )  
 

◆ Entity() [3/3]

Entity ( Entity const & copy_from )  
 

Member Function Documentation

◆ bounding_box()

std::array< double, 6 > bounding_box (   )  

Get the bounding box of the Entity .

std::array<double,6> b_box = entity->bounding_box();
b_box = entity.bounding_box()
Returns
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

◆ center_point()

std::array< double, 3 > center_point (   )  

Get the center point of the Entity .

std::array<double,3> center = entity->center_point();
center = entity.center_point()
Returns
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

◆ destroy_cubit_entity()

void destroy_cubit_entity (   )  
 

◆ entity_ptr()

CubitEntity * entity_ptr (   )  
 

◆ id()

int id (   )  

Get the id of the Entity .

intid = entity->id();
id = entity.id()
Returns
The id of the Entity

◆ is_transparent() [1/2]

int is_transparent (   )  

Get the tranparency state of the Entity .

int trans = entity->is_transparent();
trans = entity.is_transparent()
Returns
The current transparency state of the Entity (1 if transparent, 0 if not)

◆ is_transparent() [2/2]

void is_transparent ( int transparency_flag )  

Set the tranparency state of the Entity .

entity->is_transparent(1);
entity.is_transparent(1)
Parameters
[in] transparency_flag The flag that sets whether the Entity is transparent (1) or not (0)

◆ is_visible() [1/2]

int is_visible (   )  

Get the visibility state of the Entity .

int vis = entity->is_visible();
vis = entity.is_visible()
Returns
The current visiblity state of the Entity (1 if visible, 0 if not)

◆ is_visible() [2/2]

void is_visible ( bool visibility_flag )  

Set the visibility state of the Entity .

entity->is_visible(1);
entity.is_visible(1)
Parameters
[in] visibility_flag The flag that sets whether the Entity is visible (1) or not (0)

◆ operator=()

Entity & operator= ( const Entity & rhs )  
 

◆ set_transparent()

void set_transparent ( int transparency_flag )  

Set the tranparency state of the Entity .

entity->set_transparent(1);
entity.set_transparent(1)
Parameters
[in] transparency_flag The flag that sets whether the Entity is transparent (1) or not (0)

◆ set_visible()

void set_visible ( bool visibility_flag )  

Set the visibility state of the Entity .

entity->set_visible(1);
entity.set_visible(1)
Parameters
[in] visibility_flag The flag that sets whether the Entity is visible (1) or not (0)

Member Data Documentation

◆ CubitWatcher

CubObserver* CubitWatcher
protected
 

◆ mEntityPtr

CubitEntity* mEntityPtr
protected