VuoBase< CompilerClass, RendererClass > Class Template Reference

Description

template<class CompilerClass, class RendererClass>
class VuoBase< CompilerClass, RendererClass >

This class is intended to be inherited by a base class that can have compiler and/or renderer detail classes.

It's similar to the Entity Component System (ECS) design pattern — VuoBase is the Entity; VuoBaseDetail is the common parent class for the compiler and renderer Components.

Template Parameters

CompilerClass	The base class's compiler detail class.
RendererClass	The base class's renderer detail class.

See also

VuoBaseDetail

Definition at line 24 of file VuoBase.hh.

Public Member Functions
	VuoBase (string id)
	Creates a base class. More...
void	setCompiler (CompilerClass *compiler)
	Sets the base class instance's compiler detail class instance. More...
CompilerClass *	getCompiler (void) const
	Returns the base class instance's compiler detail class instance. More...
bool	hasCompiler (void) const
	Returns true if this base class instance has a compiler detail. More...
void	setRenderer (RendererClass *renderer)
	Sets the base class instance's renderer detail class instance. More...
RendererClass *	getRenderer (void) const
	Returns the base class instance's renderer detail class instance. More...
bool	hasRenderer (void) const
	Returns true if this base class instance has a renderer detail. More...

Constructor & Destructor Documentation

VuoBase()

template<class CompilerClass , class RendererClass >

VuoBase< CompilerClass, RendererClass >::VuoBase

(

string

id

)

Creates a base class.

Parameters

id	The name of the base class inheriting VuoBase.

Definition at line 18 of file VuoBase.cc.

Member Function Documentation

getCompiler()

template<class CompilerClass , class RendererClass >

CompilerClass * VuoBase< CompilerClass, RendererClass >::getCompiler

(

void

)

const

Returns the base class instance's compiler detail class instance.

Definition at line 39 of file VuoBase.cc.

getRenderer()

template<class CompilerClass , class RendererClass >

RendererClass * VuoBase< CompilerClass, RendererClass >::getRenderer

(

void

)

const

Returns the base class instance's renderer detail class instance.

Definition at line 74 of file VuoBase.cc.

hasCompiler()

template<class CompilerClass , class RendererClass >

bool VuoBase< CompilerClass, RendererClass >::hasCompiler

(

void

)

const

Returns true if this base class instance has a compiler detail.

Definition at line 56 of file VuoBase.cc.

hasRenderer()

template<class CompilerClass , class RendererClass >

bool VuoBase< CompilerClass, RendererClass >::hasRenderer

(

void

)

const

Returns true if this base class instance has a renderer detail.

Definition at line 91 of file VuoBase.cc.

setCompiler()

template<class CompilerClass , class RendererClass >

void VuoBase< CompilerClass, RendererClass >::setCompiler

(

CompilerClass *

compiler

)

Sets the base class instance's compiler detail class instance.

Definition at line 30 of file VuoBase.cc.

setRenderer()

template<class CompilerClass , class RendererClass >

void VuoBase< CompilerClass, RendererClass >::setRenderer

(

RendererClass *

renderer

)

Sets the base class instance's renderer detail class instance.

Definition at line 65 of file VuoBase.cc.

---

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

• base/VuoBase.hh
• base/VuoBase.cc