Workspace 6.21.5
Public Member Functions | List of all members
WSGLSceneItemSymbolLibrary Class Reference

Contains a set of mesh model 'symbols', which can be used to represent the set of SceneItems that are not MeshModelInstances. The symbol library contains its own MeshModelLibrary, as well as a MeshModelSource and MeshModelInstance for each symbol.

#include <Rendering/OpenGL/wsglsceneitemsymbollibrary.h>

Public Member Functions

 WSGLSceneItemSymbolLibrary ()
 
 ~WSGLSceneItemSymbolLibrary ()
 
MeshModelInstancegetCameraFrustumSymbol (const Camera &camera, int viewportWidth, int viewportHeight)
 
Mesh::MeshModelLibrarygetMeshModelLibrary () const
 
MeshModelInstancegetSymbol (const Camera &camera)
 
MeshModelInstancegetSymbol (const ClipRegion &clipRegion)
 
MeshModelInstancegetSymbol (const Light &light)
 
MeshModelInstancegetSymbol (const Manipulator &manip)
 
MeshModelInstancegetSymbol (const Transform &transform)
 
void setCameraFrustumColors (const QColor &faceColor, const QColor &lineColor)
 
void setSymbolColor (const QColor &color)
 
void setSymbolLineWidth (const double &width)
 

Constructor & Destructor Documentation

◆ WSGLSceneItemSymbolLibrary()

◆ ~WSGLSceneItemSymbolLibrary()

Member Function Documentation

◆ getCameraFrustumSymbol()

MeshModelInstance * getCameraFrustumSymbol ( const Camera camera,
int  viewportWidth,
int  viewportHeight 
)
Parameters
cameraThe camera for which we are creating frustum geometry.
viewportWidthWidth of the viewport that the frustum is being produced for.
viewportHeightHeight of the viewport that the frustum is being produced for.
Returns
a MeshModelInstance that instances the camera frustum mesh.

◆ getMeshModelLibrary()

Mesh::MeshModelLibrary & getMeshModelLibrary ( ) const
Returns
The MeshModelLibrary that contains all of the MeshModelSources used to draw the symbols.

◆ getSymbol() [1/5]

MeshModelInstance * getSymbol ( const Camera camera)
Parameters
cameraThe Camera for which we are retrieving a symbol.
Returns
A reference to a MeshModelInstance that represents the Camera.

◆ getSymbol() [2/5]

MeshModelInstance * getSymbol ( const ClipRegion clipRegion)
Parameters
clipRegionThe ClipRegion for which we are retrieving a symbol.
Returns
A reference to a MeshModelInstance that represents the ClipRegion.

◆ getSymbol() [3/5]

MeshModelInstance * getSymbol ( const Light light)
Parameters
lightThe Light for which we are retrieving a symbol.
Returns
A reference to a MeshModelInstance that represents the Light.

◆ getSymbol() [4/5]

MeshModelInstance * getSymbol ( const Manipulator manip)
Parameters
manipThe manipulator for which we are retrieving a symbol.
Returns
a reference to a meshmodel instance that represents the manipulator. The meshmodel is guaranteed to have a ModelId that corresponds to the cache key of the manipulator.

◆ getSymbol() [5/5]

MeshModelInstance * getSymbol ( const Transform transform)
Parameters
transformThe transform for which we are retrieving a symbol.
Returns
a reference to a model instance that represents the transform.

◆ setCameraFrustumColors()

void setCameraFrustumColors ( const QColor &  faceColor,
const QColor &  lineColor 
)
Parameters
faceColorThe desired face color of the camera frustum.
lineColorThe desired line color joining the faces of the camera frustum.

◆ setSymbolColor()

void setSymbolColor ( const QColor &  color)
Parameters
colorThe desired symbol color.

◆ setSymbolLineWidth()

void setSymbolLineWidth ( const double &  width)
Parameters
widthThe desired symbol line width.