# Home    # nevrax.com   
Nevrax
Nevrax.org
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
Docs
 
Documentation  
Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  

NLSOUND::CEnvEffect Class Reference

Environmental effects and where they are applied. More...

#include <env_effect.h>

List of all members.

Public Methods

 CEnvEffect ()
 Constructor. More...

virtual ~CEnvEffect ()
 Destructor. More...

void serial (NLMISC::IStream &s)
 Serialize. More...

bool include (const NLMISC::CVector &pos)
 Return true if the environment includes the specified point. More...

void selectEnv (const std::string &tag)
 Select the current environment. More...

TEnvEffectPreset getEnvNum () const
 Return the environment type. More...

float getEnvSize () const
 Return the environment size. More...

void addEnvNum (TEnvEffectPreset num, const std::string &tag="", float customsize=-1.0f)
 Set the environment type (EDIT). More...

IBoundingShape * getBoundingShape ()
 Access the bounding shape (EDIT). More...

void setBoundingShape (IBoundingShape *bs)
 Set the bounding shape (EDIT). More...


Static Public Methods

void serialFileHeader (NLMISC::IStream &s, uint32 &nb)
 Serialize file header. More...

uint32 load (std::vector< CEnvEffect * > &container, NLMISC::IStream &s)
 Load several EnvEffects and return the number of effects loaded. More...

void save (const std::vector< CEnvEffect > &container, NLMISC::IStream &s)
 Save (output stream only) (EDIT). More...


Private Attributes

uint8 _Current
std::vector< TEnvEffectRoom > _EnvNums
std::vector< std::string > _Tags
IBoundingShape * _BoundingShape

Detailed Description

Environmental effects and where they are applied.

Deprecated:
Author:
Olivier Cado , Nevrax France
Date:
2001

Definition at line 98 of file env_effect.h.

Constructor & Destructor Documentation

NLSOUND::CEnvEffect::CEnvEffect (    ) 
 

Constructor.

Definition at line 39 of file env_effect.cpp.

Referenced by load.

virtual NLSOUND::CEnvEffect::~CEnvEffect (    )  [inline, virtual]
 

Destructor.

Definition at line 105 of file env_effect.h.

Member Function Documentation

void NLSOUND::CEnvEffect::addEnvNum (  TEnvEffectPreset    num,
const std::string &    tag = "",
float    customsize = -1.0f
) 
 

Set the environment type (EDIT).

The size of the environment is computed with the bounding shape, unless the argument customshape is positive.

Definition at line 87 of file env_effect.cpp.

References _EnvNums, _Tags, num, and NLSOUND::TEnvEffectPreset.

IBoundingShape* NLSOUND::CEnvEffect::getBoundingShape (    )  [inline]
 

Access the bounding shape (EDIT).

Definition at line 135 of file env_effect.h.

References _BoundingShape.

TEnvEffectPreset NLSOUND::CEnvEffect::getEnvNum (    )  const [inline]
 

Return the environment type.

Definition at line 124 of file env_effect.h.

References _Current, _EnvNums, and NLSOUND::TEnvEffectPreset.

float NLSOUND::CEnvEffect::getEnvSize (    )  const
 

Return the environment size.

Definition at line 97 of file env_effect.cpp.

References _BoundingShape, _Current, and _EnvNums.

bool NLSOUND::CEnvEffect::include (  const NLMISC::CVector &    pos )  [inline]
 

Return true if the environment includes the specified point.

Definition at line 120 of file env_effect.h.

References _BoundingShape.

uint32 NLSOUND::CEnvEffect::load (  std::vector< CEnvEffect * > &    container,
NLMISC::IStream &    s
)  [static]
 

Load several EnvEffects and return the number of effects loaded.

Definition at line 62 of file env_effect.cpp.

References CEnvEffect, NLMISC::IStream::isReading, nlstop, s, NLMISC::IStream::serial, and serialFileHeader.

void NLSOUND::CEnvEffect::save (  const std::vector< CEnvEffect > &    container,
NLMISC::IStream &    s
)  [static]
 

Save (output stream only) (EDIT).

Definition at line 133 of file env_effect.cpp.

References NLMISC::IStream::isReading, nlassert, s, NLMISC::IStream::serial, and serialFileHeader.

void NLSOUND::CEnvEffect::selectEnv (  const std::string &    tag ) 
 

Select the current environment.

Definition at line 113 of file env_effect.cpp.

References _Current, _Tags, and nldebug.

void NLSOUND::CEnvEffect::serial (  NLMISC::IStream &    s )  [inline]
 

Serialize.

Definition at line 107 of file env_effect.h.

References _BoundingShape, _EnvNums, _Tags, s, NLMISC::IStream::serialCont, and NLMISC::IStream::serialPolyPtr.

void NLSOUND::CEnvEffect::serialFileHeader (  NLMISC::IStream &    s,
uint32 &    nb
)  [static]
 

Serialize file header.

Definition at line 47 of file env_effect.cpp.

References s, NLMISC::IStream::serial, NLMISC::IStream::serialCheck, and NLMISC::IStream::serialVersion.

Referenced by load, and save.

void NLSOUND::CEnvEffect::setBoundingShape (  IBoundingShape *    bs )  [inline]
 

Set the bounding shape (EDIT).

Definition at line 137 of file env_effect.h.

References _BoundingShape.

Member Data Documentation

IBoundingShape* NLSOUND::CEnvEffect::_BoundingShape [private]
 

Definition at line 154 of file env_effect.h.

Referenced by getBoundingShape, getEnvSize, include, serial, and setBoundingShape.

uint8 NLSOUND::CEnvEffect::_Current [private]
 

Definition at line 145 of file env_effect.h.

Referenced by getEnvNum, getEnvSize, and selectEnv.

std::vector<TEnvEffectRoom> NLSOUND::CEnvEffect::_EnvNums [private]
 

Definition at line 148 of file env_effect.h.

Referenced by addEnvNum, getEnvNum, getEnvSize, and serial.

std::vector<std::string> NLSOUND::CEnvEffect::_Tags [private]
 

Definition at line 151 of file env_effect.h.

Referenced by addEnvNum, selectEnv, and serial.

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