1. Home
  2. Documentation
  3. API
  4. WireframeManager Class Reference

WireframeManager Class Reference

#include <WireframeManager.h>

Inheritance diagram for WireframeManager:
ComponentManager

# Public Member Functions

void constructor ()
 Class' constructor.
override bool onEvent (ListenerObject eventFirer, uint16 eventCode)
override uint32 getType ()
override void enable ()
 Enable the manager.
override void disable ()
 Disable the manager.
override Wireframe create (Entity owner, const WireframeSpec *wireframeSpec)
override bool areComponentsVisual ()
void enable ()
 Enable wireframe rendering and drawing.
void disable ()
 Disable wireframe rendering and drawing.
void render ()
 Prepare wireframe's graphical data for drawing.
void invalidateRendering ()
 Invalidate the rendering status of all wireframes so they re-render again in the next cycle.
void showAllWireframes ()
 Show all wireframes (available only when __TOOLS is defined).
void hideAllWireframes ()
 Hide all wireframes (available only when __TOOLS is defined).
bool hasWireframes ()
void print (int32 x, int32 y)

# Protected Attributes

volatile bool stopRendering
 Flag used to break the rendering due to high frame time.
volatile bool stopDrawing
 Flag used to break the drawing due to high frame time.
bool evenFrame
 Flag to distinguish between even and odd game frames.
uint8 renderedWireframes
 Number of rendered wireframes during the last game cycle.
uint8 drawnWireframes
 Number of drawing wireframes during the last game cycle.

# Additional Inherited Members

- Private Member Functions inherited from ComponentManager
void constructor ()
 Class' constructor.
void destroyAllComponents ()
 Destroy all the manager's components.
virtual Component create (Entity owner, const ComponentSpec *componentSpec)=0
virtual void purgeComponents ()
 Force the purging of deleted components.
- Static Private Member Functions inherited from ComponentManager
static Component createComponent (Entity owner, const ComponentSpec *componentSpec)
static void destroyComponent (Entity owner, Component component)
static Component addComponent (Entity owner, const ComponentSpec *componentSpec)
static void removeComponent (Entity owner, Component component)
static void addComponents (Entity owner, ComponentSpec **componentSpecs, uint32 componentType)
static void removeComponents (Entity owner, uint32 componentType)
static void createComponents (Entity owner, ComponentSpec **componentSpecs)
static void destroyComponents (Entity owner)
static Component getComponentAtIndex (Entity owner, uint32 componentType, int16 componentIndex)
static void getComponents (Entity owner, uint32 componentType, VirtualList components)
static bool getComponentsOfClass (Entity owner, ClassPointer classPointer, VirtualList components, uint32 componentType)
static uint16 getComponentsCount (Entity owner, uint32 componentType)
static void propagateCommand (int32 command, Entity owner, uint32 componentType,...)
static bool calculateRightBox (Entity owner, RightBox *rightBox)
- Private Attributes inherited from ComponentManager
VirtualList components
 List of components.
bool locked
 Flag to prevent the manipulation of the components list.

# Detailed Description

Class WireframeManager

Inherits from ComponentManager

Manages instances of Wireframe.

Definition at line 35 of file WireframeManager.h.

# Member Function Documentation

# areComponentsVisual()

bool WireframeManager::areComponentsVisual ( )
virtual

Retrieve information regarding if the components are visile.

Returns
True if the components managed are visual; false otherwise

Reimplemented from ComponentManager.

Definition at line 133 of file WireframeManager.c.

# constructor()

void WireframeManager::constructor ( )

Class' constructor.

Definition at line 38 of file WireframeManager.c.

# create()

Wireframe WireframeManager::create ( Entity owner,
const WireframeSpec * wireframeSpec )

Create a wireframe with the provided spec.

Parameters
ownerObject to which the wireframe will attach to
wireframeSpecSpec to use to create the wireframe
Returns
Created wireframe

Definition at line 116 of file WireframeManager.c.

# disable() [1/2]

void WireframeManager::disable ( )
virtual

Disable the manager.

Reimplemented from ComponentManager.

Definition at line 105 of file WireframeManager.c.

# disable() [2/2]

void WireframeManager::disable ( )
virtual

Disable wireframe rendering and drawing.

Reimplemented from ComponentManager.

# enable() [1/2]

void WireframeManager::enable ( )
virtual

Enable the manager.

Reimplemented from ComponentManager.

Definition at line 98 of file WireframeManager.c.

# enable() [2/2]

void WireframeManager::enable ( )
virtual

Enable wireframe rendering and drawing.

Reimplemented from ComponentManager.

# getType()

uint32 WireframeManager::getType ( )
virtual

Retrieve the compoment type that the manager manages.

Returns
Component type

Implements ComponentManager.

Definition at line 91 of file WireframeManager.c.

# hasWireframes()

bool WireframeManager::hasWireframes ( )

Check if there are any registered wireframes.

Returns
True if there are any registered wireframes; false otherwise

Definition at line 297 of file WireframeManager.c.

# hideAllWireframes()

void WireframeManager::hideAllWireframes ( )

Hide all wireframes (available only when __TOOLS is defined).

# invalidateRendering()

void WireframeManager::invalidateRendering ( )

Invalidate the rendering status of all wireframes so they re-render again in the next cycle.

Definition at line 213 of file WireframeManager.c.

# onEvent()

bool WireframeManager::onEvent ( ListenerObject eventFirer,
uint16 eventCode )
virtual

Process an event that the instance is listen for.

Parameters
eventFirerListenerObject that signals the event
eventCodeCode of the firing event
Returns
False if the listener has to be removed; true to keep it

Reimplemented from ListenerObject.

Definition at line 62 of file WireframeManager.c.

# print()

void WireframeManager::print ( int32 x,
int32 y )

Print the manager's state.

Parameters
xScreen x coordinate where to print
yScreen y coordinate where to print

Definition at line 305 of file WireframeManager.c.

# render()

void WireframeManager::render ( )

Prepare wireframe's graphical data for drawing.

Definition at line 140 of file WireframeManager.c.

# showAllWireframes()

void WireframeManager::showAllWireframes ( )

Show all wireframes (available only when __TOOLS is defined).

# Member Data Documentation

# drawnWireframes

uint8 WireframeManager::drawnWireframes
protected

Number of drawing wireframes during the last game cycle.

Definition at line 52 of file WireframeManager.h.

# evenFrame

bool WireframeManager::evenFrame
protected

Flag to distinguish between even and odd game frames.

Definition at line 46 of file WireframeManager.h.

# renderedWireframes

uint8 WireframeManager::renderedWireframes
protected

Number of rendered wireframes during the last game cycle.

Definition at line 49 of file WireframeManager.h.

# stopDrawing

volatile bool WireframeManager::stopDrawing
protected

Flag used to break the drawing due to high frame time.

Definition at line 43 of file WireframeManager.h.

# stopRendering

volatile bool WireframeManager::stopRendering
protected

Flag used to break the rendering due to high frame time.

Definition at line 40 of file WireframeManager.h.


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