Main Page | Namespace List | Alphabetical List | Class List | File List | Class Members | Related Pages

DART_Actors::SketchActor Class Reference

Actor that provides a 3D polygon texture mapped with images the developer defines used most often for storyboards and animatics. More...

List of all members.

Public Member Functions

 new (me)
 getPropertyDescriptionList (aScript)
 beginSprite (me)
 initFrames (me)
 initAudio (me)
 createModel (me)
 getFrame (me, time)
 getTime (me)
 enterFrame (me)
 displayFrame (me, newFrame)
 CleanUp (me)
 StartActor (me, param1)
 StopActor (me, param1)
 PauseActor (me, param1)
 UnPauseActor (me, param1)
 ChangeClockRate (me, rateMultiplier)
 ChangeClockPosition (me)
 GoToCurrentSegment (me)
 GoToPreviousSegment (me)
 GoToNextSegment (me)
 GoToSegment (me, newSegment)

Private Attributes

 pActorCast
 The video that should be used for this actor.

 pAudioEnabled
 Is there audio to be played.

 pActorHeight
 initial height of the video actor

 pActorWidth
 initial width of the video actor

 pOpacity
 the default opacity of the video actor

 pParentSprite
 the sprite number of the other actor you want to make the parent of this actor

 pQuitOnAudio
 user indicates whether the video actor should stop based on the frames or on the audio

 ActorDone
 TRUE when this actor is done, meaning the stop time has been reached.

 AudioSprite
 the sprite that contains the audio clip

 AudioChannel
 the channel the video actor audio is on

 AudioPlaying
 TRUE if the current audio segment has already started playing, FALSE if not.

 actortexture
 the texture of the actor

 actorshader
 the shader used for this actor

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

 paused
 TRUE if the video is currently paused.

 startTime
 the time the actor started

 previousFrame
 the name of the previous image that was

 previousFrameMember
 the member image that was previously displayed

 pauseTime
 when this actor was paused

 timelineList
 the timeline defined by the user

 AudioType
 Necessary for media events..

 volumeBeforeMute
 volume before mutting audio

 pSoundVolume
 the volume level of the audio that is playing

 pInitSuccessful
 Will be set to true if the all the requirements for the successful initialization are met.


Detailed Description

Actor that provides a 3D polygon texture mapped with images the developer defines used most often for storyboards and animatics.

Timing of the display of images is defined in a text file that accompanies the images. Standard Actor methods are available such as start, stop, pause, unpause as well as 3D positioning.

Properties:

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::SketchActor::beginSprite me   ) 
 

DART_Actors::SketchActor::ChangeClockPosition me   ) 
 

DART_Actors::SketchActor::ChangeClockRate me  ,
rateMultiplier 
 

DART_Actors::SketchActor::CleanUp me   ) 
 

DART_Actors::SketchActor::createModel me   ) 
 

DART_Actors::SketchActor::displayFrame me  ,
newFrame 
 

DART_Actors::SketchActor::enterFrame me   ) 
 

DART_Actors::SketchActor::getFrame me  ,
time 
 

DART_Actors::SketchActor::getPropertyDescriptionList aScript   ) 
 

DART_Actors::SketchActor::getTime me   ) 
 

DART_Actors::SketchActor::GoToCurrentSegment me   ) 
 

DART_Actors::SketchActor::GoToNextSegment me   ) 
 

DART_Actors::SketchActor::GoToPreviousSegment me   ) 
 

DART_Actors::SketchActor::GoToSegment me  ,
newSegment 
 

DART_Actors::SketchActor::initAudio me   ) 
 

DART_Actors::SketchActor::initFrames me   ) 
 

DART_Actors::SketchActor::new me   ) 
 

DART_Actors::SketchActor::PauseActor me  ,
param1 
 

DART_Actors::SketchActor::StartActor me  ,
param1 
 

DART_Actors::SketchActor::StopActor me  ,
param1 
 

DART_Actors::SketchActor::UnPauseActor me  ,
param1 
 


Member Data Documentation

DART_Actors::SketchActor::ActorDone [private]
 

TRUE when this actor is done, meaning the stop time has been reached.

DART_Actors::SketchActor::actorshader [private]
 

the shader used for this actor

DART_Actors::SketchActor::actortexture [private]
 

the texture of the actor

DART_Actors::SketchActor::AudioChannel [private]
 

the channel the video actor audio is on

DART_Actors::SketchActor::AudioPlaying [private]
 

TRUE if the current audio segment has already started playing, FALSE if not.

DART_Actors::SketchActor::AudioSprite [private]
 

the sprite that contains the audio clip

DART_Actors::SketchActor::AudioType [private]
 

Necessary for media events..

DART_Actors::SketchActor::modeltexture [private]
 

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

DART_Actors::SketchActor::pActorCast [private]
 

The video that should be used for this actor.

DART_Actors::SketchActor::pActorHeight [private]
 

initial height of the video actor

DART_Actors::SketchActor::pActorWidth [private]
 

initial width of the video actor

DART_Actors::SketchActor::pAudioEnabled [private]
 

Is there audio to be played.

DART_Actors::SketchActor::paused [private]
 

TRUE if the video is currently paused.

DART_Actors::SketchActor::pauseTime [private]
 

when this actor was paused

DART_Actors::SketchActor::pInitSuccessful [private]
 

Will be set to true if the all the requirements for the successful initialization are met.

DART_Actors::SketchActor::pOpacity [private]
 

the default opacity of the video actor

DART_Actors::SketchActor::pParentSprite [private]
 

the sprite number of the other actor you want to make the parent of this actor

DART_Actors::SketchActor::pQuitOnAudio [private]
 

user indicates whether the video actor should stop based on the frames or on the audio

DART_Actors::SketchActor::previousFrame [private]
 

the name of the previous image that was

DART_Actors::SketchActor::previousFrameMember [private]
 

the member image that was previously displayed

DART_Actors::SketchActor::pSoundVolume [private]
 

the volume level of the audio that is playing

DART_Actors::SketchActor::startTime [private]
 

the time the actor started

DART_Actors::SketchActor::timelineList [private]
 

the timeline defined by the user

DART_Actors::SketchActor::volumeBeforeMute [private]
 

volume before mutting audio


Generated on Fri Oct 8 16:37:59 2004 for DART-Lingo by doxygen 1.3.7