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

Detailed Description

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

Member Enumeration Documentation

Mode

enum RenderingMode::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(), and SURFACE.

RenderingMode() [2/2]

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

inline

another constructor provided for conveniance

Parameters

surface	tells if by default the surface is visible
wireframe	tells if by default the surface is visible
points	tells if by default the surface is visible

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

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.

getModeString()

std::string RenderingMode::getModeString ( ) const

inline

get the string equivalent to the enum rendering mode

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.

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().

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
value	is 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().

---

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

• RenderingMode.h
• RenderingMode.cpp