ug4
ug::OctahedronDescriptor Class Reference

only used to initialize a octahedron. for all other tasks you should use VolumeDescripor. More...

#include <grid_objects_3d.h>

Public Member Functions

uint num_vertices () const
 
 OctahedronDescriptor ()
 
 OctahedronDescriptor (const OctahedronDescriptor &td)
 
 OctahedronDescriptor (const VolumeVertices &vv)
 
 OctahedronDescriptor (Vertex *v1, Vertex *v2, Vertex *v3, Vertex *v4, Vertex *v5, Vertex *v6)
 
Vertexvertex (size_t index) const
 

Protected Attributes

Vertexm_vertex [6]
 

Detailed Description

only used to initialize a octahedron. for all other tasks you should use VolumeDescripor.

please be sure to pass the vertices in the correct order: v1: bottom-vertex v2, v3, v4, v5: middle-section-vertices in counterclockwise order (if viewed from the top). v6: top-vertex

Constructor & Destructor Documentation

◆ OctahedronDescriptor() [1/4]

ug::OctahedronDescriptor::OctahedronDescriptor ( )
inline

◆ OctahedronDescriptor() [2/4]

ug::OctahedronDescriptor::OctahedronDescriptor ( const OctahedronDescriptor td)

References vertex().

◆ OctahedronDescriptor() [3/4]

ug::OctahedronDescriptor::OctahedronDescriptor ( const VolumeVertices vv)

◆ OctahedronDescriptor() [4/4]

ug::OctahedronDescriptor::OctahedronDescriptor ( Vertex v1,
Vertex v2,
Vertex v3,
Vertex v4,
Vertex v5,
Vertex v6 
)

Member Function Documentation

◆ num_vertices()

uint ug::OctahedronDescriptor::num_vertices ( ) const
inline

◆ vertex()

Vertex* ug::OctahedronDescriptor::vertex ( size_t  index) const
inline

Member Data Documentation

◆ m_vertex

Vertex* ug::OctahedronDescriptor::m_vertex[6]
protected

The documentation for this class was generated from the following files: