Computer Assisted Medical Intervention Tool Kit  version 5.2
RenderingMode Class Reference

Handle rendering options (surface and wireframe) of an Object3D. More...

#include <RenderingMode.h>

+ Collaboration diagram for RenderingMode:

Public Types

enum  Mode {
  NONE , POINTS , POINTS_AND_SURFACE , SURFACE ,
  WIREFRAME_AND_SURFACE , WIREFRAME_AND_POINTS , WIREFRAME , WIREFRAME_AND_SURFACE_AND_POINTS
}
 This is a duplicate of RenderingMode Mode.... More...
 

Public Member Functions

RenderingMode::Mode getMode () const
 get current mode More...
 
std::string getModeString () const
 get the string equivalent to the enum rendering mode More...
 
bool isVisible () const
 Return true if at least a mode is currently visible, false otherwise. More...
 
bool isVisible (const Mode mode) const
 Return if a rendering mode is currently visible or not. More...
 
 RenderingMode (const bool surface, const bool wireframe, const bool points)
 another constructor provided for conveniance More...
 
 RenderingMode (const Mode mode=SURFACE)
 default constructor with initialisation More...
 
void setMode (const Mode mode)
 set a vizualisation mode More...
 
void setVisible (const Mode mode, const bool value)
 Set a rendering mode visible or not. More...
 

Detailed Description

Handle rendering options (surface and wireframe) of an Object3D.

Member Enumeration Documentation

◆ Mode

This is a duplicate of RenderingMode Mode....

BEURK!!!

Enumerator
NONE 
POINTS 
POINTS_AND_SURFACE 
SURFACE 
WIREFRAME_AND_SURFACE 
WIREFRAME_AND_POINTS 
WIREFRAME 
WIREFRAME_AND_SURFACE_AND_POINTS 

Constructor & Destructor Documentation

◆ RenderingMode() [1/2]

RenderingMode::RenderingMode ( const Mode  mode = SURFACE)
inline

default constructor with initialisation

References setMode().

+ Here is the call graph for this function:

◆ RenderingMode() [2/2]

RenderingMode::RenderingMode ( const bool  surface,
const bool  wireframe,
const bool  points 
)
inline

another constructor provided for conveniance

Parameters
surfacetells if by default the surface is visible
wireframetells if by default the surface is visible
pointstells if by default the surface is visible

References POINTS, setVisible(), SURFACE, and WIREFRAME.

+ Here is the call graph for this function:

Member Function Documentation

◆ getMode()

RenderingMode::Mode RenderingMode::getMode ( ) const
inline

get current mode

References NONE, POINTS, POINTS_AND_SURFACE, SURFACE, WIREFRAME, WIREFRAME_AND_POINTS, WIREFRAME_AND_SURFACE, and WIREFRAME_AND_SURFACE_AND_POINTS.

Referenced by StructuralComponentProperties::getMode(), and StructuralComponentProperties::xmlPrint().

+ Here is the caller graph for this function:

◆ getModeString()

std::string RenderingMode::getModeString ( ) const
inline

get the string equivalent to the enum rendering mode

Referenced by StructuralComponentProperties::getModeString(), and StructuralComponentProperties::xmlPrint().

+ Here is the caller graph for this function:

◆ isVisible() [1/2]

bool RenderingMode::isVisible ( ) const
inline

Return true if at least a mode is currently visible, false otherwise.

◆ isVisible() [2/2]

bool RenderingMode::isVisible ( const Mode  mode) const
inline

Return if a rendering mode is currently visible or not.

Return TRUE if the rendering mode

Parameters
mode(Mode) is currently visible, FALSE otherwise..

References POINTS, POINTS_AND_SURFACE, SURFACE, WIREFRAME, WIREFRAME_AND_POINTS, WIREFRAME_AND_SURFACE, and WIREFRAME_AND_SURFACE_AND_POINTS.

Referenced by StructuralComponentProperties::isVisible().

+ Here is the caller graph for this function:

◆ setMode()

void RenderingMode::setMode ( const Mode  mode)
inline

set a vizualisation mode

References NONE, POINTS, POINTS_AND_SURFACE, SURFACE, WIREFRAME, WIREFRAME_AND_POINTS, WIREFRAME_AND_SURFACE, and WIREFRAME_AND_SURFACE_AND_POINTS.

Referenced by RenderingMode(), and StructuralComponentProperties::setMode().

+ Here is the caller graph for this function:

◆ setVisible()

void RenderingMode::setVisible ( const Mode  mode,
const bool  value 
)
inline

Set a rendering mode visible or not.

Set the rendering mode

Parameters
mode(Mode) visible if
valueis TRUE, unvisible otherwise.

References POINTS, POINTS_AND_SURFACE, SURFACE, WIREFRAME, WIREFRAME_AND_POINTS, WIREFRAME_AND_SURFACE, and WIREFRAME_AND_SURFACE_AND_POINTS.

Referenced by RenderingMode(), and StructuralComponentProperties::setVisible().

+ Here is the caller graph for this function:

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