DART_Actors::VideoActor Class Reference

Actor that provides a 3D polygon texture mapped with video. More...

List of all members.

Public Member Functions
	new (me)
	getPropertyDescriptionList (aScript)
	beginSprite (me)
	initAudio (me)
	createModel (me)
	enterFrame (me)
	findSegment (me, frameNo)
	displayFrame (me, newFrame)
	GoToCurrentSegment (me)
	GoToPreviousSegment (me)
	GoToNextSegment (me)
	GoToSegment (me, newSegment)
	StartActor (me, param1)
	StopActor (me, param1)
	CleanUp (me)
	PauseActor (me, param1)
	UnPauseActor (me, param1)
	ChangeClockRate (me, rateMultiplier)
	ChangeClockPosition (me)
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
	pFPS
	frames per second the video should be played at
	pFrameRateUnit
	user indicates whether there frame rate indicates frames per second or seconds per frame
	pOpacity
	the default opacity of the video actor
	pQuitOnAudio
	user indicates whether the video actor should stop based on the frames or on the audio
	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
	time this actor started
	castList
	list of casts that make up this video
	currentSegment
	the current segment that is being played
	previousFrame
	previous frame number that was played
	previousFrameMember
	previous member of frame that was played
	pauseTime
	time this actor was paused
	AudioType
	Necessary for media events..
	volumeBeforeMute
	volume before mutting audio
	pSoundVolume
	the volume level of the audio that is playing

---

Detailed Description

Actor that provides a 3D polygon texture mapped with video.

The video is saved as individual frames in on or more casts. An accompanying text file describes the order that "segments" of video divided up among more than one cast should be played. Standard Actor methods are available such as start, stop, pause, unpause as well as 3D positioning.

Properties:

• pActorCast -- The cast that contains the images you wish to play.
• pFrameRateUnit -- will the number given for frame rate be in frames per second or seconds per frame
• pFPS -- framerate that video should be played at
• pAudioEnabled -- If TRUE audio in the video casts will be played
• pOpacity -- The opacity of the polygon and texture.
• pActorHeight -- The height of the actor polygon (cm).
• pActorWidth -- The width of the actor polygon (cm).

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

DART_Actors::VideoActor::ChangeClockPosition (  me   )

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

DART_Actors::VideoActor::CleanUp (  me   )

DART_Actors::VideoActor::createModel (  me   )

DART_Actors::VideoActor::displayFrame (  me  , newFrame  )

DART_Actors::VideoActor::enterFrame (  me   )

DART_Actors::VideoActor::findSegment (  me  , frameNo  )

DART_Actors::VideoActor::getPropertyDescriptionList (  aScript   )

DART_Actors::VideoActor::GoToCurrentSegment (  me   )

DART_Actors::VideoActor::GoToNextSegment (  me   )

DART_Actors::VideoActor::GoToPreviousSegment (  me   )

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

DART_Actors::VideoActor::initAudio (  me   )

DART_Actors::VideoActor::new (  me   )

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

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

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

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

---

Member Data Documentation

DART_Actors::VideoActor::actorshader [private]

the shader used for this actor

DART_Actors::VideoActor::actortexture [private]

the texture of the actor

DART_Actors::VideoActor::AudioChannel [private]

the channel the video actor audio is on

DART_Actors::VideoActor::AudioPlaying [private]

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

DART_Actors::VideoActor::AudioSprite [private]

the sprite that contains the audio clip

DART_Actors::VideoActor::AudioType [private]

Necessary for media events..

DART_Actors::VideoActor::castList [private]

list of casts that make up this video

DART_Actors::VideoActor::currentSegment [private]

the current segment that is being played

DART_Actors::VideoActor::modeltexture [private]

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

DART_Actors::VideoActor::pActorCast [private]

The video that should be used for this actor.

DART_Actors::VideoActor::pActorHeight [private]

initial height of the video actor

DART_Actors::VideoActor::pActorWidth [private]

initial width of the video actor

DART_Actors::VideoActor::pAudioEnabled [private]

Is there audio to be played.

DART_Actors::VideoActor::paused [private]

TRUE if the video is currently paused.

DART_Actors::VideoActor::pauseTime [private]

time this actor was paused

DART_Actors::VideoActor::pFPS [private]

frames per second the video should be played at

DART_Actors::VideoActor::pFrameRateUnit [private]

user indicates whether there frame rate indicates frames per second or seconds per frame

DART_Actors::VideoActor::pOpacity [private]

the default opacity of the video actor

DART_Actors::VideoActor::pQuitOnAudio [private]

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

DART_Actors::VideoActor::previousFrame [private]

previous frame number that was played

DART_Actors::VideoActor::previousFrameMember [private]

previous member of frame that was played

DART_Actors::VideoActor::pSoundVolume [private]

the volume level of the audio that is playing

DART_Actors::VideoActor::startTime [private]

time this actor started

DART_Actors::VideoActor::volumeBeforeMute [private]

volume before mutting audio

---