Room¶

Uninitializes this room.

void Amplitude::Room::Clear () 

Note:

This doesn't destroy the internal state it references, it just removes this reference to it.

Note:

To completely destroy the room, use the RemoveRoom() method of the Engine instance.

amEngine->RemoveRoom(1234); // You should provide the room ID

Gets the dimensions of the room in meters.

AmVector3 Amplitude::Room::GetDimensions () const

Returns:

The dimensions of the room's shape.

Gets the direction vector of this room.

AmVector3 Amplitude::Room::GetDirection () const

Returns:

The direction (forward) vector.

Gets the room effects gain.

AmReal32 Amplitude::Room::GetGain () const

Returns:

The room effects gain.

Returns the unique ID of this room.

AmRoomID Amplitude::Room::GetId () const

Returns:

The room's unique ID.

Gets the current location of this room.

const AmVector3 & Amplitude::Room::GetLocation () const

Returns:

The current location of this room.

Gets the current orientation of this room.

const Orientation & Amplitude::Room::GetOrientation () const

Returns:

The current orientation of this room.

Gets the shape representing this room.

const BoxShape & Amplitude::Room::GetShape () const

Returns:

The room shape.

Gets the internal state of the room.

RoomInternalState * Amplitude::Room::GetState () const

Returns:

The room's internal state.

Warning:

This method is for internal usage only.

Gets the surface area for a specific wall of this room.

AmReal32 Amplitude::Room::GetSurfaceArea (
    eRoomWall wall
) const

Parameters:

• wall The wall to get the surface area for.

Returns:

The surface area of the specified wall.

Gets the up vector of this room.

AmVector3 Amplitude::Room::GetUp () const

Returns:

The up vector.

Gets the volume of the room in m3.

AmReal32 Amplitude::Room::GetVolume () const

Returns:

The volume of the room's shape.

Gets the material for a specific wall of this room.

const RoomWallMaterial & Amplitude::Room::GetWallMaterial (
    eRoomWall wall
) const

Parameters:

• wall The wall to get the material for.

Returns:

The material of the specified wall.

Creates an uninitialized room.

Amplitude::Room::Room () 

Note:

An uninitialized room doesn't affect sound sources.

Note:

To create an initialized room, use the AddRoom() method of the Engine instance.

amEngine->AddRoom(1234); // You should provide a unique ID

Creates a wrapper instance over the provided state.

explicit Amplitude::Room::Room (
    RoomInternalState * state
) 

Parameters:

• state The internal state to wrap.

Warning:

This constructor is for internal usage only.

Sets the material for all walls of this room.

void Amplitude::Room::SetAllWallMaterials (
    const RoomWallMaterial & material
) const

Parameters:

• material The new material.

Sets the shape's dimensions of this room.

void Amplitude::Room::SetDimensions (
    AmVector3 dimensions
) const

Parameters:

• dimensions The new dimensions.

Sets the room effects gain.

void Amplitude::Room::SetGain (
    AmReal32 gain
) const

Parameters:

• gain The gain applied to early reflections and reverberations effects.

Sets the location room.

void Amplitude::Room::SetLocation (
    const AmVector3 & location
) const

Parameters:

• location The new location.

Sets the orientation of this room.

void Amplitude::Room::SetOrientation (
    const Orientation & orientation
) const

Parameters:

• orientation The new orientation.

Sets the shape representing this room.

void Amplitude::Room::SetShape (
    const BoxShape & shape
) const

Parameters:

• shape The new shape.

Sets the material for a specific wall of this room.

void Amplitude::Room::SetWallMaterial (
    eRoomWall wall,
    const RoomWallMaterial & material
) const

Parameters:

• wall The wall to set the material for.
• material The new material.

Sets the material for each wall of this room.

void Amplitude::Room::SetWallMaterials (
    const RoomWallMaterial & leftWallMaterial,
    const RoomWallMaterial & rightWallMaterial,
    const RoomWallMaterial & floorMaterial,
    const RoomWallMaterial & ceilingMaterial,
    const RoomWallMaterial & frontWallMaterial,
    const RoomWallMaterial & backWallMaterial
) const

Parameters:

• leftWallMaterial The material for the left wall.
• rightWallMaterial The material for the right wall.
• floorMaterial The material for the floor.
• ceilingMaterial The material for the ceiling.
• frontWallMaterial The material for the front wall.
• backWallMaterial The material for the back wall.

Updates the state of this room.

void Amplitude::Room::Update () const

The Engine calls this method automatically on each frame to update the internal state of the room.

Warning:

This method is for internal usage only.

Checks whether this room has been initialized.

bool Amplitude::Room::Valid () const

Returns:

true if this room has been initialized with a valid state, false otherwise.