Computer Assited Medical Intervention Tool Kit  version 3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Types | Public Member Functions | Private Attributes | List of all members
RenderingMode Class Reference

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

#include <RenderingMode.h>

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 Mode mode) const
 Return if a rendering mode is currently visible or not. More...
 
bool isVisible () const
 Return true if at least a mode is currently visible, false otherwise. More...
 
 RenderingMode (const Mode mode=SURFACE)
 default constructor with initialisation More...
 
 RenderingMode (const bool surface, const bool wireframe, const bool points)
 another constructor provided for conveniance 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...
 

Private Attributes

bool pointsVisibility
 Flag indicating weither the points mode is currenly visible or not. More...
 
bool surfaceVisibility
 Flag indicating weither the surface mode is currenly visible or not. More...
 
bool wireframeVisibility
 Flag indicating weither the wireframe mode is currenly visible or not. More...
 

Detailed Description

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

Constructor & Destructor Documentation

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

default constructor with initialisation

References setMode().

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.

Member Function Documentation

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

get the string equivalent to the enum rendering mode

References pointsVisibility, surfaceVisibility, and wireframeVisibility.

Referenced by BasicSCProperties::beginXML(), and BasicSCProperties::getModeString().

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

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

References pointsVisibility, surfaceVisibility, and wireframeVisibility.

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

Member Data Documentation

bool RenderingMode::pointsVisibility
private

Flag indicating weither the points mode is currenly visible or not.

Referenced by getMode(), getModeString(), isVisible(), setMode(), and setVisible().

bool RenderingMode::surfaceVisibility
private

Flag indicating weither the surface mode is currenly visible or not.

Referenced by getMode(), getModeString(), isVisible(), setMode(), and setVisible().

bool RenderingMode::wireframeVisibility
private

Flag indicating weither the wireframe mode is currenly visible or not.

Referenced by getMode(), getModeString(), isVisible(), setMode(), and setVisible().


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