SFXSoundscape

Engine/source/sfx/sfxSoundscape.h

An instance of an SFXAmbience on the soundscape mixer stack.

Public Types

enum

DirtyBits {
  AmbienceDirty = BIT( 0 )
  AllDirty = 0xFFFFFFFF
}

enum

Flags {
  FlagOverridden = BIT( 0 )
  FlagUnique = BIT( 1 )
}

void

Parent

Public Friends

class

SFXSoundscapeManager

Protected Attributes

SFXAmbience *

mAmbience

The ambient space assigned to this soundscape.

BitSet32

mDirtyBits

BitSet32

mFlags

SimObjectPtr< SFXSource >

mSource

The current soundtrack playing in this soundscape.

SFXState *

mStates [SFXAmbience::MaxStates]

States activated by this soundscape.

Protected Functions

bool

_isOverridden()

Return true if another soundscape lower down the stack is using the same ambient space as this soundscape.

bool

_isUnique()

Return true if this soundscape is the only soundscape using the assigned ambient space.

Public Functions

SFXSoundscape(SFXAmbience * ambience)

Create a soundscape associated with the given ambient space.

SFXAmbience *

getAmbience()

Return the ambient space associated with this soundscape.

void

setAmbience(SFXAmbience * ambience)

Set the ambient space associated with this soundscape.

Detailed Description

An instance of an SFXAmbience on the soundscape mixer stack.

Public Types

DirtyBits

Enumerator

AmbienceDirty = BIT( 0 ): Associated ambience has changed.
AllDirty = 0xFFFFFFFF

Flags

Enumerator

FlagOverridden = BIT( 0 ): Same ambience is pushed lower down onto the stack.
FlagUnique = BIT( 1 ): No other instance of this ambience on stack.

typedef void Parent

Public Friends

Protected Attributes

SFXAmbience * mAmbience

The ambient space assigned to this soundscape.

BitSet32 mDirtyBits

BitSet32 mFlags

SimObjectPtr< SFXSource > mSource

The current soundtrack playing in this soundscape.

This is either the ambient track or the surround sound track depending on whether

SFXState * mStates [SFXAmbience::MaxStates]

States activated by this soundscape.

Protected Functions

_isOverridden()

Return true if another soundscape lower down the stack is using the same ambient space as this soundscape.

_isUnique()

Return true if this soundscape is the only soundscape using the assigned ambient space.

Public Functions

SFXSoundscape(SFXAmbience * ambience)

Create a soundscape associated with the given ambient space.

getAmbience()

Return the ambient space associated with this soundscape.

setAmbience(SFXAmbience * ambience)

Set the ambient space associated with this soundscape.

Triggers corresponding recomputations on the next soundscape manager update.