Main Page | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages | Search for 

NLSOUND::CClusteredSound::CSoundTravContext Struct Reference

#include <clustered_sound.h>

Detailed Description

This structure is used when we traverse the cluster/portal graph.

Definition at line 90 of file clustered_sound.h.

Public Member Functions

 CSoundTravContext (const NLMISC::CVector &listenerPos, bool filterUnvisibleChild, bool filterUnvisibleFather)
 Constructor. Init all default value.

CSoundTravContext & operator= (const CSoundTravContext &other)
 Assignment operator.


Data Fields

float Alpha
 A blending factor to compute virtual source position.

NLMISC::CVector Direction
 The current blended direction used to place vitual source.

NLMISC::CVector Direction1
 The direction vector from listener to the first portal/cluster.

NLMISC::CVector Direction2
 The direction vector from the first portal/cluster to the second one.

float Dist
 The distance acumulator.

bool FilterUnvisibleChild
 A flag that indicate if we need to filter the unvisible child.

bool FilterUnvisibleFather
 A flag that iindicate if we need to filter the unvisible father.

float Gain
 The current gain.

NLMISC::CVector ListenerPos
 The last pseudo listener position.

uint NbPortal
 The number of traversed portals.

sint32 Obstruction
sint32 Occlusion
float OcclusionLFFactor
float OcclusionRoomRatio
NL3D::CCluster * PreviousCluster
 The previously traversed cluster. Used to stop back traversal.

NLMISC::CVector PreviousVector
 The previous sound propagation vector.

Constructor & Destructor Documentation

NLSOUND::CClusteredSound::CSoundTravContext::CSoundTravContext (  const NLMISC::CVector &  listenerPos,
bool  filterUnvisibleChild,
bool  filterUnvisibleFather
)  [inline]
 

Constructor. Init all default value.

Definition at line 123 of file clustered_sound.h.

References Direction1, Direction2, FilterUnvisibleChild, FilterUnvisibleFather, ListenerPos, NbPortal, PreviousCluster, and PreviousVector. 

00125                         :       ListenerPos(listenerPos),
00126                                 Gain(1.0f),
00127                                 Occlusion(0),
00128                                 OcclusionLFFactor(1.0f),
00129                                 OcclusionRoomRatio(1.0f),
00130                                 Obstruction(0),
00131                                 Dist(0),
00132                                 FilterUnvisibleChild(filterUnvisibleChild),
00133                                 FilterUnvisibleFather(filterUnvisibleFather),
00134                                 NbPortal(0),
00135                                 Alpha(0.0f),
00136                                 Direction1(NLMISC::CVector::Null),
00137                                 Direction2(NLMISC::CVector::Null),
00138                                 Direction(NLMISC::CVector::Null),
00139                                 PreviousCluster(0),
00140                                 PreviousVector(NLMISC::CVector::Null)
00141                 {}

Member Function Documentation

CSoundTravContext& NLSOUND::CClusteredSound::CSoundTravContext::operator= (  const CSoundTravContext &  other  )  [inline]
 

Assignment operator.

Definition at line 144 of file clustered_sound.h.

References Alpha, Direction, Direction1, Direction2, Dist, FilterUnvisibleChild, FilterUnvisibleFather, Gain, ListenerPos, NbPortal, Obstruction, Occlusion, OcclusionLFFactor, OcclusionRoomRatio, PreviousCluster, and PreviousVector. 

00145                 {
00146                         Gain = other.Gain;
00147                         Occlusion = other.Occlusion;
00148                         OcclusionLFFactor = other.OcclusionLFFactor;
00149                         OcclusionRoomRatio = other.OcclusionRoomRatio;
00150                         Obstruction = other.Obstruction;
00151                         Dist = other.Dist;
00152                         FilterUnvisibleChild = other.FilterUnvisibleChild;
00153                         FilterUnvisibleFather = other.FilterUnvisibleFather;
00154                         NbPortal = other.NbPortal;
00155                         Alpha = other.Alpha;
00156                         Direction1 = other.Direction1;
00157                         Direction2 = other.Direction2;
00158                         Direction = other.Direction;
00159                         PreviousCluster = other.PreviousCluster;
00160                         ListenerPos = other.ListenerPos;
00161                         PreviousVector = other.PreviousVector;
00162                         return *this;
00163                 }

Field Documentation

float NLSOUND::CClusteredSound::CSoundTravContext::Alpha
 

A blending factor to compute virtual source position.

Definition at line 107 of file clustered_sound.h.

Referenced by operator=(), and NLSOUND::CClusteredSound::soundTraverse().

NLMISC::CVector NLSOUND::CClusteredSound::CSoundTravContext::Direction
 

The current blended direction used to place vitual source.

Definition at line 113 of file clustered_sound.h.

Referenced by operator=(), and NLSOUND::CClusteredSound::soundTraverse().

NLMISC::CVector NLSOUND::CClusteredSound::CSoundTravContext::Direction1
 

The direction vector from listener to the first portal/cluster.

Definition at line 109 of file clustered_sound.h.

Referenced by CSoundTravContext(), operator=(), and NLSOUND::CClusteredSound::soundTraverse().

NLMISC::CVector NLSOUND::CClusteredSound::CSoundTravContext::Direction2
 

The direction vector from the first portal/cluster to the second one.

Definition at line 111 of file clustered_sound.h.

Referenced by CSoundTravContext(), operator=(), and NLSOUND::CClusteredSound::soundTraverse().

float NLSOUND::CClusteredSound::CSoundTravContext::Dist
 

The distance acumulator.

Definition at line 99 of file clustered_sound.h.

Referenced by NLSOUND::CClusteredSound::addNextTraverse(), operator=(), and NLSOUND::CClusteredSound::soundTraverse().

bool NLSOUND::CClusteredSound::CSoundTravContext::FilterUnvisibleChild
 

A flag that indicate if we need to filter the unvisible child.

Definition at line 101 of file clustered_sound.h.

Referenced by CSoundTravContext(), operator=(), and NLSOUND::CClusteredSound::soundTraverse().

bool NLSOUND::CClusteredSound::CSoundTravContext::FilterUnvisibleFather
 

A flag that iindicate if we need to filter the unvisible father.

Definition at line 103 of file clustered_sound.h.

Referenced by CSoundTravContext(), operator=(), and NLSOUND::CClusteredSound::soundTraverse().

float NLSOUND::CClusteredSound::CSoundTravContext::Gain
 

The current gain.

Definition at line 93 of file clustered_sound.h.

Referenced by operator=(), and NLSOUND::CClusteredSound::soundTraverse().

NLMISC::CVector NLSOUND::CClusteredSound::CSoundTravContext::ListenerPos
 

The last pseudo listener position.

Definition at line 120 of file clustered_sound.h.

Referenced by CSoundTravContext(), operator=(), and NLSOUND::CClusteredSound::soundTraverse().

uint NLSOUND::CClusteredSound::CSoundTravContext::NbPortal
 

The number of traversed portals.

Definition at line 105 of file clustered_sound.h.

Referenced by CSoundTravContext(), NLSOUND::CClusteredSound::interpolateSourceDirection(), operator=(), and NLSOUND::CClusteredSound::soundTraverse().

sint32 NLSOUND::CClusteredSound::CSoundTravContext::Obstruction
 

Definition at line 97 of file clustered_sound.h.

Referenced by operator=(), and NLSOUND::CClusteredSound::soundTraverse().

sint32 NLSOUND::CClusteredSound::CSoundTravContext::Occlusion
 

Definition at line 94 of file clustered_sound.h.

Referenced by operator=(), and NLSOUND::CClusteredSound::soundTraverse().

float NLSOUND::CClusteredSound::CSoundTravContext::OcclusionLFFactor
 

Definition at line 95 of file clustered_sound.h.

Referenced by operator=(), and NLSOUND::CClusteredSound::soundTraverse().

float NLSOUND::CClusteredSound::CSoundTravContext::OcclusionRoomRatio
 

Definition at line 96 of file clustered_sound.h.

Referenced by operator=(), and NLSOUND::CClusteredSound::soundTraverse().

NL3D::CCluster* NLSOUND::CClusteredSound::CSoundTravContext::PreviousCluster
 

The previously traversed cluster. Used to stop back traversal.

Definition at line 115 of file clustered_sound.h.

Referenced by CSoundTravContext(), operator=(), and NLSOUND::CClusteredSound::soundTraverse().

NLMISC::CVector NLSOUND::CClusteredSound::CSoundTravContext::PreviousVector
 

The previous sound propagation vector.

Definition at line 117 of file clustered_sound.h.

Referenced by CSoundTravContext(), operator=(), and NLSOUND::CClusteredSound::soundTraverse().

The documentation for this struct was generated from the following file:
Generated on Tue Mar 16 14:35:25 2004 for NeL by doxygen 1.3.6