Chemical Data Processing Library Python API - Version 1.4.0
Public Member Functions | List of all members
CDPL.Vis.TorusMesh3D Class Reference

Pre-defined triangle mesh providing the vertices and faces of a torus specified by the contructor arguments. More...

+ Inheritance diagram for CDPL.Vis.TorusMesh3D:

Public Member Functions

None __init__ (float radius1, float radius2, int num_sect1, int num_sect2, float start_angle=0.0, float first_sect_size=0.0)
 Constructs a torus triangle mesh with the specified ring radius, tube radius, ring/tube subdivision counts and optional start-angle/first-section sizing. More...
 
None __init__ (TorusMesh3D mesh)
 Initializes a copy of the TorusMesh3D instance mesh. More...
 
- Public Member Functions inherited from CDPL.Vis.TriangleMesh3D
None __init__ ()
 Initializes the TriangleMesh3D instance.
 
None __init__ (TriangleMesh3D mesh)
 Initializes a copy of the TriangleMesh3D instance mesh. More...
 
TriangleMesh3D assign (TriangleMesh3D mesh)
 Replaces the current state of self with a copy of the state of the TriangleMesh3D instance mesh. More...
 
Math.Vector3DArray getVertices ()
 Returns a reference to the array storing the mesh vertices. More...
 
None addVertex (float x, float y, float z)
 Appends a new vertex at the position (x, y, z). More...
 
int getNumVertices ()
 Returns the number of stored vertices. More...
 
Math.Vector3DArray getVertexNormals ()
 Returns a reference to the array storing the per-vertex normals. More...
 
None addVertexNormal (float x, float y, float z)
 Appends a new vertex normal with the components (x, y, z). More...
 
int getNumVertexNormals ()
 Returns the number of stored vertex normals. More...
 
Math.Vector3ULArray getFaces ()
 Returns a reference to the array storing the triangle faces (vertex-index triplets). More...
 
None addFace (int v1_idx, int v2_idx, int v3_idx)
 Appends a new triangle face defined by the three vertex indices v1_idx, v2_idx and v3_idx. More...
 
int getNumFaces ()
 Returns the number of stored triangle faces. More...
 
bool isClosed ()
 Tells whether the mesh has been flagged as a closed surface. More...
 
None setClosed (bool closed=True)
 Sets the flag that marks the mesh as a closed surface. More...
 
None clear ()
 Removes all vertices, vertex normals and faces and resets the closed-surface flag.
 
TriangleMesh3D swap (TriangleMesh3D mesh)
 Swaps the contents of this mesh with those of mesh. More...
 
TriangleMesh3D __iadd__ (TriangleMesh3D mesh)
 Performs the in-place addition operation self += mesh. More...
 
- Public Member Functions inherited from CDPL.Vis.Shape3D
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
Shape3D clone ()
 Creates a dynamically allocated copy of the graphics primitive. More...
 
None accept (Shape3DVisitor visitor)
 Vis.Shape3DVisitor implementation accept method [VPTN]. More...
 

Additional Inherited Members

- Properties inherited from CDPL.Vis.TriangleMesh3D
 vertices = property(getVertices)
 
 numVertices = property(getNumVertices)
 
 vertexNormals = property(getVertexNormals)
 
 numVertexNormals = property(getNumVertexNormals)
 
 faces = property(getFaces)
 
 numFaces = property(getNumFaces)
 
 closed = property(isClosed, setClosed)
 
- Properties inherited from CDPL.Vis.Shape3D
 objectID = property(getObjectID)
 

Detailed Description

Pre-defined triangle mesh providing the vertices and faces of a torus specified by the contructor arguments.

Since
1.3

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Vis.TorusMesh3D.__init__ ( float  radius1,
float  radius2,
int  num_sect1,
int  num_sect2,
float   start_angle = 0.0,
float   first_sect_size = 0.0 
)

Constructs a torus triangle mesh with the specified ring radius, tube radius, ring/tube subdivision counts and optional start-angle/first-section sizing.

Parameters
radius1The radius of the torus ring (distance from the torus center to the tube center).
radius2The radius of the tube.
num_sect1The number of sections subdividing the torus ring.
num_sect2The number of sections subdividing the tube.
start_angleThe angle (in radians) at which the first ring section starts.
first_sect_sizeThe angular size of the first ring section (0 to use a uniform section size).

◆ __init__() [2/2]

None CDPL.Vis.TorusMesh3D.__init__ ( TorusMesh3D  mesh)

Initializes a copy of the TorusMesh3D instance mesh.

Parameters
meshThe TorusMesh3D instance to copy.