SnowManager Class Reference

#include <Snow.h>

Inherits SubsystemInterface.

Inherited by W3DSnowManager.

Public Types
enum	{ SNOW_NOISE_X =64 , SNOW_NOISE_Y =64 }

Public Member Functions
	SnowManager (void)
	~SnowManager (void)
virtual void	init (void)
virtual void	reset (void)
virtual void	updateIniSettings (void)
void	setVisible (Bool showWeather)
	enable/disable rendering of weather - assuming it's available on map.
Public Member Functions inherited from SubsystemInterface
	SubsystemInterface ()
virtual	~SubsystemInterface ()
virtual void	postProcessLoad ()
virtual void	update ()=0
virtual void	draw (void)
void	UPDATE (void)
void	DRAW (void)
AsciiString	getName (void)
void	setName (AsciiString name)

Protected Attributes
Real *	m_startingHeights
Real	m_time
	time elapsed since it started snowing.
Real	m_velocity
	positive velocity of falling snow
Real	m_fullTimePeriod
	time for snow to complete a full animation cycle.
Real	m_frequencyScaleX
	used to adjust snow position.
Real	m_frequencyScaleY
	used to adjust snow position.
Real	m_amplitude
	used to adjust amount of of snow movement.
Real	m_pointSize
	used to control hardware point-sprite size.
Real	m_maxPointSize
	used to control maximum pixel size of sprites.
Real	m_minPointSize
	used to control minimum pixel size of sprites.
Real	m_quadSize
	used to control quad size when no hardware point sprites.
Real	m_boxDimensions
	used to set dimensions of box surrounding camera.
Real	m_emitterSpacing
	used to control how many emitters are present per world unit
Bool	m_isVisible
	used to prevent map weather (if defined) from rendering.
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

Definition at line 83 of file Snow.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SNOW_NOISE_X
SNOW_NOISE_Y

Definition at line 86 of file Snow.h.

Constructor & Destructor Documentation

SnowManager()

SnowManager::SnowManager

(

void

)

Definition at line 42 of file Snow.cpp.

~SnowManager()

SnowManager::~SnowManager

(

void

)

Definition at line 98 of file Snow.cpp.

Member Function Documentation

init()

void SnowManager::init ( void )

virtual

• Assign any default values to data required for the class
  • Allocate any memory and resources needed throughout the lifetime of the class

Implements SubsystemInterface.

Reimplemented in W3DSnowManager.

Definition at line 49 of file Snow.cpp.

reset()

void SnowManager::reset ( void )

virtual

• Any system should be able to reset all data and go back to an empty state that is ready to accept a completely new set of data. Reset() can expect to be used in the context of resetting the engine in order to start or load a new game.
  • Do NOT free and re-allocate resources needed, where possible reorganize and re-initialize the resources already allocated.
  • After a reset, the system does not need to be in EXACTLY the same state as a fresh instantiation. If there are persistent state information for the system make sure you maintain it while restoring or re-initializing other transient parts.

Implements SubsystemInterface.

Reimplemented in W3DSnowManager.

Definition at line 93 of file Snow.cpp.

setVisible()

void SnowManager::setVisible

(

Bool

showWeather

)

enable/disable rendering of weather - assuming it's available on map.

Definition at line 88 of file Snow.cpp.

updateIniSettings()

void SnowManager::updateIniSettings ( void )

virtual

Reimplemented in W3DSnowManager.

Definition at line 59 of file Snow.cpp.

Member Data Documentation

m_amplitude

Real SnowManager::m_amplitude

protected

used to adjust amount of of snow movement.

Definition at line 107 of file Snow.h.

m_boxDimensions

Real SnowManager::m_boxDimensions

protected

used to set dimensions of box surrounding camera.

Definition at line 112 of file Snow.h.

m_emitterSpacing

Real SnowManager::m_emitterSpacing

protected

used to control how many emitters are present per world unit

Definition at line 113 of file Snow.h.

m_frequencyScaleX

Real SnowManager::m_frequencyScaleX

protected

used to adjust snow position.

Definition at line 105 of file Snow.h.

m_frequencyScaleY

Real SnowManager::m_frequencyScaleY

protected

used to adjust snow position.

Definition at line 106 of file Snow.h.

m_fullTimePeriod

Real SnowManager::m_fullTimePeriod

protected

time for snow to complete a full animation cycle.

Definition at line 104 of file Snow.h.

m_isVisible

Bool SnowManager::m_isVisible

protected

used to prevent map weather (if defined) from rendering.

Definition at line 114 of file Snow.h.

m_maxPointSize

Real SnowManager::m_maxPointSize

protected

used to control maximum pixel size of sprites.

Definition at line 109 of file Snow.h.

m_minPointSize

Real SnowManager::m_minPointSize

protected

used to control minimum pixel size of sprites.

Definition at line 110 of file Snow.h.

m_pointSize

Real SnowManager::m_pointSize

protected

used to control hardware point-sprite size.

Definition at line 108 of file Snow.h.

m_quadSize

Real SnowManager::m_quadSize

protected

used to control quad size when no hardware point sprites.

Definition at line 111 of file Snow.h.

m_startingHeights

Real* SnowManager::m_startingHeights

protected

Definition at line 101 of file Snow.h.

m_time

Real SnowManager::m_time

protected

time elapsed since it started snowing.

Definition at line 102 of file Snow.h.

m_velocity

Real SnowManager::m_velocity

protected

positive velocity of falling snow

Definition at line 103 of file Snow.h.

---

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

• Code/GameEngine/Include/GameClient/Snow.h
• Code/GameEngine/Source/GameClient/Snow.cpp