Cubit Python API  17.05
Public Member Functions
Vertex

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

Inheritance diagram for Vertex:
GeomEntity Entity

Public Member Functions

def  color (self)
  Get the color of the Vertex. More...
 
def  coordinates (self)
  Get the Cartesian coordinates of the Vertex. More...
 
def  set_color (self, value)
  Set the color of the Vertex. More...
 
- Public Member Functions inherited from GeomEntity
def  bodies (self)
  Retrieve bodies contained within the geometry entity. More...
 
def  curves (self)
  Retrieve curves (edges) associated with the geometry entity. More...
 
def  dimension (self)
  Get the topological dimension of the geometry entity. More...
 
def  entity_name (self)
  Retrieve the primary name of the geometry entity. More...
 
def  entity_names (self)
  Retrieve all names assigned to the geometry entity. More...
 
def  is_meshed (self)
  Returns the current mesh state of the GeomEntity. More...
 
def  is_transparent (self)
  Get the transparency state of the geometry entity. More...
 
def  is_visible (self)
  Get the visibility state of the geometry entity. More...
 
def  mesh (self)
  Generates mesh on a GeomEntity and verifies meshing status. More...
 
def  num_names (self)
  Get the count of names assigned to the geometry entity. More...
 
def  remove_entity_name (self, name)
  Remove a specific name from the geometry entity. More...
 
def  remove_entity_names (self)
  Remove all non-default names from the geometry entity. More...
 
def  remove_mesh (self)
  Remove any mesh associated with the geometry entity. More...
 
def  set_entity_name (self, name)
  Assign a name to the geometry entity. More...
 
def  set_transparent (self, transparency_flag)
  Set the transparency state of the geometry entity. More...
 
def  set_visible (self, visibility_flag)
  Set and verify the visibility state of the geometry entity. More...
 
def  smooth (self)
  Smooths the mesh on a GeomEntity to improve element quality. More...
 
def  surfaces (self)
  Retrieve surfaces associated with the geometry entity. More...
 
def  vertices (self)
  Retrieve vertices (points) associated with the geometry entity. More...
 
def  volumes (self)
  Retrieve volumes associated with the geometry entity. More...
 
- Public Member Functions inherited from Entity
def  bounding_box (self)
  Returns the axis-aligned bounding box of the Entity. More...
 
def  center_point (self)
  Returns the geometric center point of the Entity. More...
 
def  id (self)
  Retrieves the unique identifier of the Entity. More...
 

Detailed Description

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

Member Function Documentation

◆ color()

def color (   self )

Get the color of the Vertex .

.. code-block:: python

col = vertex.color()
   @n return type of : std:: array< double,4 >
Returns
The color value associated with the vertex's current color.

◆ coordinates()

def coordinates (   self )

Get the Cartesian coordinates of the Vertex .

.. code-block:: python

position = vertex.coordinates()
     @n return type of : std:: array< double,3 >
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

◆ set_color()

def set_color (   self,
  value 
)

Set the color of the Vertex .

.. code-block:: python

vertex.set_color(0)
   @n type of value:  std::array< double,4 >, in
Parameters
value The color value that the vertex will have.