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
Vertex

Defines a vertex object that mostly parallels Cubit's RefVertex class. More...

#include <CubitInterfaceEx.hpp>

Inheritance diagram for Vertex:
GeomEntity Entity

Public Member Functions
  Vertex ()
 
  Vertex (const Vertex &other)
 
  Vertex (CubitEntity *entity_ptr)
 
  ~Vertex ()
 
std::array< double, 4 > color ()
  Get the color of the Vertex.
 
std::array< double, 3 > coordinates ()
  Get the Cartesian coordinates of the Vertex.
 
Vertex & operator= (const Vertex &other)
 
void set_color (std::array< double, 4 > value)
  Set the color of the Vertex.
 
- Public Member Functions inherited from GeomEntity
std::vector< Body > bodies ()
  Get the bodies in the GeomEntity.
 
std::vector< Curve > curves ()
  Get the curves in the GeomEntity.
 
int dimension ()
  Get the dimensions of the GeomEntity.
 
std::string entity_name ()
  Return the first name of the GeomEntity.
 
void entity_name (std::string name)
  Assign a name to the GeomEntity.
 
std::vector< std::string > entity_names ()
  Return the all the names of the GeomEntity.
 
bool is_meshed ()
  Return the current mesh state of the GeomEntity.
 
void mesh ()
  Mesh the GeomEntity.
 
int num_names ()
  Return the number of names for the GeomEntity.
 
void remove_entity_name (std::string name)
  Remove a specific name from the list of names assigned to the GeomEntity.
 
void remove_entity_names ()
  Remove all the names assigned to the GeomEntity.
 
void remove_mesh ()
  Removes the mesh on the GeomEntity.
 
void set_entity_name (std::string name)
  Assign a name to the GeomEntity.
 
void smooth ()
  Smooths the mesh on the GeomEntity.
 
std::vector< Surface > surfaces ()
  Get the surfaces in the GeomEntity.
 
std::vector< Vertex > vertices ()
  Get the vertices in the GeomEntity.
 
std::vector< Volume > volumes ()
  Get the volumes in the GeomEntity.
 
- Public Member Functions inherited from Entity
  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.
 

Additional Inherited Members
- Protected Member Functions inherited from GeomEntity
  GeomEntity (const GeomEntity &other)
 
  GeomEntity (CubitEntity *entity_ptr)
 
- Protected Attributes inherited from Entity
CubObserver * CubitWatcher
 
CubitEntity * mEntityPtr
 

Detailed Description

Defines a vertex object that mostly parallels Cubit's RefVertex class.

Constructor & Destructor Documentation

◆ Vertex() [1/3]

Vertex (   )  
inline
 

◆ ~Vertex()

~Vertex (   )  
inline
 

◆ Vertex() [2/3]

Vertex ( const Vertex & other )  
inline
 

◆ Vertex() [3/3]

Vertex ( CubitEntity * entity_ptr )  
inline
 

Member Function Documentation

◆ color()

std::array< double, 4 > color (   )  

Get the color of the Vertex .

int col = vertex ->color ();
CubitInterface::Vertex::color
std::array< double, 4 > color()
Get the color of the Vertex.
CubitInterface::vertex
CubitInterface::Vertex vertex(int id_in)
Gets the vertex object from an ID.
col = vertex .color ()
Returns
The color value associated with the vertex's current color

◆ coordinates()

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

Get the Cartesian coordinates of the Vertex .

std::vector<double> position = vertex ->coordinates ();
CubitInterface::Vertex::coordinates
std::array< double, 3 > coordinates()
Get the Cartesian coordinates of the Vertex.
position = vertex .coordinates ()
Returns
A vector containing the coordinates of the Vertex with indices corresponding to the coordinates as follows:
0 - x coordinate
1 - y coordinate
2 - z coordinate

◆ operator=()

Vertex & operator= ( const Vertex & other )  
inline
 

◆ set_color()

void set_color ( std::array< double, 4 > value )  

Set the color of the Vertex .

vertex ->set_color (0);
CubitInterface::Vertex::set_color
void set_color(std::array< double, 4 > value)
Set the color of the Vertex.
vertex .set_color (0)
Parameters
[in] value The color value that the vertex will have