NDEVR
API Documentation
QuickVisualization::VertexVisualizationOptions

Options controlling how a set of 3D vertices is visualized as coordinate markers or connected linework within a Model. More...

Collaboration diagram for QuickVisualization::VertexVisualizationOptions:
[legend]

Public Member Functions

 VertexVisualizationOptions ()
 Constructs default vertex visualization options with no vertices or labels.
 VertexVisualizationOptions (const Buffer< Vertex< 3, fltp08 > > &vertices)
 Constructs vertex visualization options with the given vertices and no labels.
 VertexVisualizationOptions (const Buffer< Vertex< 3, fltp08 > > &vertices, const Buffer< String > &labels)
 Constructs vertex visualization options with the given vertices and labels.

Public Attributes

bool connect_linework = false
 Whether to connect vertices with lines rather than showing isolated points.
fltp04 extra_reserve_factor = 1.0
 Multiplier for pre-allocating extra buffer capacity (1.0 = exact fit).
uint04 index_per_label = 1
 The number of vertices each label covers.
Buffer< Stringlabels
 Optional text labels applied to groups of vertices.
uint04 start_index = 0
 The starting index into the vertex buffer for visualization.
Buffer< Vertex< 3, fltp08 > > vertices
 The 3D positions of the vertices to visualize.

Detailed Description

Options controlling how a set of 3D vertices is visualized as coordinate markers or connected linework within a Model.


Definition at line 19 of file QuickVisualization.h.

Constructor & Destructor Documentation

◆ VertexVisualizationOptions() [1/3]

QuickVisualization::VertexVisualizationOptions::VertexVisualizationOptions ( )
inline

Constructs default vertex visualization options with no vertices or labels.


Definition at line 24 of file QuickVisualization.h.

◆ VertexVisualizationOptions() [2/3]

QuickVisualization::VertexVisualizationOptions::VertexVisualizationOptions ( const Buffer< Vertex< 3, fltp08 > > & vertices)
inline

Constructs vertex visualization options with the given vertices and no labels.


Parameters
[in]verticesThe 3D vertex positions to visualize.

Definition at line 30 of file QuickVisualization.h.

References vertices.

◆ VertexVisualizationOptions() [3/3]

QuickVisualization::VertexVisualizationOptions::VertexVisualizationOptions ( const Buffer< Vertex< 3, fltp08 > > & vertices,
const Buffer< String > & labels )
inline

Constructs vertex visualization options with the given vertices and labels.


Parameters
[in]verticesThe 3D vertex positions to visualize.
[in]labelsText labels to associate with groups of vertices.

Definition at line 39 of file QuickVisualization.h.

References labels, and vertices.


The documentation for this struct was generated from the following file: