DART_Actors::_3DAudioActor Class Reference

Actor that represents spatialized sounds in the application.Standard Actor methods are available such as start, stop, pause, unpause as well as 3D positioning. More...

List of all members.

Public Member Functions
	new (me)
	getPropertyDescriptionList (aScript)
	createModel (me)
	beginSprite (me)
	enterframe (me)
	DeleteActor (me)
	StartActor (me, param1)
	Starts the actor (that means that the sound will start to play).
	StopActor (me, param1)
	PauseActor (me, param1)
	UnPauseActor (me, param1)
	MuteSound (me)
	UnMuteSound (me)
	IncrementVolumeLevel (me, incamount)
	DecrementVolumeLevel (me, incamount)
	SetVolumeLevel (me, volumelevel)
	GoToCurrentSegment (me)
	GoToPreviousSegment (me)
	GoToNextSegment (me)
	GoToSegment (me, newSegment)
	ChangeClockRate (me, rateMultiplier)
	ChangeClockPosition ()
Private Attributes
	actormodel
	the object actor group
	actortexture
	the texture of the actor
	actorshader
	the shader used for this actor
	tempmodels
	hold models to be placed in group
	temptransforms
	hold original transforms of each model in group
	modeltexture
	the unique string used as the name for the actor texture resource
	groupname
	unique string used as the name for the actor plane model and model resource
	actorres
	the model resource for the actor object
	Omodel
	occlusion model placeholder
	Vmodel
	virtual mode placeholder
	currentmodel
	the current model
	IsCamera
	FALSE in the case of actors.
	volumeBeforeMute
	save volume so it can be unmuted

---

Detailed Description

Actor that represents spatialized sounds in the application.Standard Actor methods are available such as start, stop, pause, unpause as well as 3D positioning.

Properties:

• pActorCast -- The cast that contains the sound file(s) you wish to play.
• pActorMember -- The sound file you wish to play.
• pLoop -- The sound will be looped if TRUE.
• pSoundVolume -- The desired volume of the sound (0-255).
• pReferenceDistance -- Distance by which the volume will drop by half before being infuenced by the rolloff factor (cm)
• pReferenceDistance -- Distance attenuation value (cm)
• pShowSphere -- A sphere will be shown at the location of the sound in 3D if TRUE

Copyright 2004, Georgia Tech Research Corporation, Atlanta, Georgia 30332-0415 All Rights Reserved (See LICENSE cast member for full license information)

---

Member Function Documentation

DART_Actors::_3DAudioActor::beginSprite (  me   )

DART_Actors::_3DAudioActor::ChangeClockPosition (   )

DART_Actors::_3DAudioActor::ChangeClockRate (  me  , rateMultiplier  )

DART_Actors::_3DAudioActor::createModel (  me   )

DART_Actors::_3DAudioActor::DecrementVolumeLevel (  me  , incamount  )

DART_Actors::_3DAudioActor::DeleteActor (  me   )

DART_Actors::_3DAudioActor::enterframe (  me   )

DART_Actors::_3DAudioActor::getPropertyDescriptionList (  aScript   )

DART_Actors::_3DAudioActor::GoToCurrentSegment (  me   )

DART_Actors::_3DAudioActor::GoToNextSegment (  me   )

DART_Actors::_3DAudioActor::GoToPreviousSegment (  me   )

DART_Actors::_3DAudioActor::GoToSegment (  me  , newSegment  )

DART_Actors::_3DAudioActor::IncrementVolumeLevel (  me  , incamount  )

DART_Actors::_3DAudioActor::MuteSound (  me   )

DART_Actors::_3DAudioActor::new (  me   )

DART_Actors::_3DAudioActor::PauseActor (  me  , param1  )

DART_Actors::_3DAudioActor::SetVolumeLevel (  me  , volumelevel  )

DART_Actors::_3DAudioActor::StartActor (  me  , param1  )

Starts the actor (that means that the sound will start to play). Parameters: param1  Is not really used at the moment

DART_Actors::_3DAudioActor::StopActor (  me  , param1  )

DART_Actors::_3DAudioActor::UnMuteSound (  me   )

DART_Actors::_3DAudioActor::UnPauseActor (  me  , param1  )

---

Member Data Documentation

DART_Actors::_3DAudioActor::actormodel [private]

the object actor group

DART_Actors::_3DAudioActor::actorres [private]

the model resource for the actor object

DART_Actors::_3DAudioActor::actorshader [private]

the shader used for this actor

DART_Actors::_3DAudioActor::actortexture [private]

the texture of the actor

DART_Actors::_3DAudioActor::currentmodel [private]

the current model

DART_Actors::_3DAudioActor::groupname [private]

unique string used as the name for the actor plane model and model resource

DART_Actors::_3DAudioActor::IsCamera [private]

FALSE in the case of actors.

DART_Actors::_3DAudioActor::modeltexture [private]

the unique string used as the name for the actor texture resource

DART_Actors::_3DAudioActor::Omodel [private]

occlusion model placeholder

DART_Actors::_3DAudioActor::tempmodels [private]

hold models to be placed in group

DART_Actors::_3DAudioActor::temptransforms [private]

hold original transforms of each model in group

DART_Actors::_3DAudioActor::Vmodel [private]

virtual mode placeholder

DART_Actors::_3DAudioActor::volumeBeforeMute [private]

save volume so it can be unmuted

---