Classes
class	Beatlight
	The Beatlight shows a moving point indicating beat impulses. More...
class	CoverArt
	The cover artwork image is displayed. More...
class	ProcessMonitor
	Shows some information on screen for diagnostical and monitoring purposes. More...
class	TemplateAction
	Performs the action of the TemplateActor. More...
class	TrackLyrics
	Shows the lyrics of the current audio track. More...
class	TrackTitle
	Shows the title of the current audio track. More...
class	BeatlightActor
	A beat indicating VisualActor. More...
class	CoverArtActor
	A visual representation of the album cover art data included with the audio track. More...
class	ProcessMonitorActor
	This actor displays textual and graphical information useful for debugging, diagnostics and monitoring purposes. More...
class	TemplateActor
	A template of a VisualActor. More...
class	TrackLyricsActor
	The lyrics of the audio track are displayed as texture with blended colors. More...
class	TrackTitleActor
	The title of the audio track is displayed as texture with blended colors. More...
class	UpdateServiceActor
	UpdateServiceActor displays a visual update notification in case an update of the currently running visualizer is available. More...
class	VisualAudioData
	Raw audio data as received with pulse message via iTunes visualizer interface. More...
class	VisualAudioLab
	A collection of routines dealing with processing, analyzing and interpretation of audio data. More...
class	VisualAudioMetaData
	Meta data (like track name, artist name, or lyrics, etc.) of audio track or audio stream. More...
class	VisualAppleScript
	Interaction with AppleScript. More...
class	VisualAnimation
	A VisualAnimation is constructed with an AnimatedProperty. More...
class	VisualAnimationCluster
	A VisualAnimationCluster is a collection of animations where the animations run concurrently. More...
class	VisualAnimationComponent
	Abstract base class for composite implementation of Animation. More...
class	VisualAnimationQueue
	Queue of animations. More...
class	VisualAnimationSequence
	A VisualAnimationSequence is a collection of animations where the animations run sequentially. More...
class	VisualTimeline
	Time synchronized interpolation between values. More...
class	VisualTiming
	Provides facilities to deal with and calculate time values. More...
class	VisualColorTools
	Various utility functions dealing with pixel color values. More...
class	VisualDownloadQueue
	Providing networking functionality. More...
class	VisualFontManager
	Management of font resources. More...
class	VisualHistogram
	Creates histogram data. More...
class	VisualInterpolation
	Interpolation between values 0.0 and 1.0. More...
class	VisualItemIdentifier
	Identifier of an item (like e.g. More...
class	VisualNetwork
	Providing networking functionality. More...
class	VisualProgressIndicator
	A VisualProgressIndicator communicates the progress of a process. More...
class	VisualString
	Unicode string without styling or formatting information. More...
class	VisualStringStyle
	Definition of a style for a string (text). More...
class	VisualStyledString
	Unicode string with styling or formatting information. More...
class	VisualThreading
	Providing multi-threading functionality. More...
class	VisualThreadingManager
	VisualThreadingManager holds identifiers for currently running threads. More...
class	VisualUpdateManager
	Checking for, prompting for, and downloading available updates for this visualizer. More...
class	VisualActor
	VisualActor defines the interface for each specific actor. More...
class	VisualActorGraphics
	The graphics related static functions for the Visual Actors. More...
class	VisualAsset
	Dimensionless asset that contains texture, boxing information, and optional animations. More...
class	VisualCamera
	A VisualCamera. More...
class	VisualConfiguration
	Common definitions and constants that must be customized for each individual plug-in. More...
class	VisualConfigurationDialog
	Wrapper around OS specific UI implementations of the configuration dialog. More...
class	VisualConvolutionFilter
	Convolution filter for bitmap image effects. More...
class	VisualCustomization
	Collection of individual customizable functions. More...
class	VisualDataStore
	Stores essential data for the visualizer. More...
class	VisualEnsemble
	The VisualEnsemble is a group of all actors. More...
class	VisualFile
	Path information of file or directory and related operations. More...
class	VisualGraphics
	Communicates with the graphics device. More...
class	VisualGraphicsCore
	The platform specific core operations of the graphics layer are bundled with this class. More...
struct	Point2D
	A Point2D is a position in 2-dimensional planar space. More...
struct	Pixel
	A pixel is a two-dimensional point relative to physical coordinate system. More...
struct	ColoredPixel
	A colored pixel is a pixel with a color value. More...
struct	Point3D
	A Point3D is a position in 3-dimensional space. More...
struct	TexCoord
	A TexCoord is a coord position of a texture. More...
struct	CoordSize2D
	A two-dimensional size relative to logical coordinate system. More...
struct	CoordSize3D
	A three-dimensional size relative to logical coordinate system. More...
struct	PixelRect
	A two-dimensional size relative to physical coordinate system. More...
struct	Rect
	A rectangle. More...
struct	TopLeftPositionedPixelRect
	A positioned rectangle, measured in pixels. More...
struct	BottomLeftPositionedPixelRect
	A positioned rectangle, measured in pixels. More...
struct	PositionedCoordRect
	A positioned rectangle, measured in coords. More...
struct	RelationalRect
	A relational rectangle is determined by aspect ratio of width and height and orientation. More...
struct	Box
	A box. More...
struct	PositionedBox
	A positioned box. More...
struct	RGBAColor
	Stores the values of a composite color of red, green, blue and alpha. More...
struct	VertexPosition
	Stores the coord position values used by a vertex. More...
struct	TexCoordPosition
	Stores the s and t coordinate values of texture positions. More...
class	VisualImage
	Bitmap raster image. More...
class	VisualMain
	Handles the events and messages passed in by iTunes. More...
class	VisualMainAction
	Dispatches the events and messages passed in by iTunes with no internal state. More...
class	VisualNotification
	A VisualActor is notified about events and messages with a VisualNotification. More...
class	VisualNotificationQueue
	Queue of notifications. More...
class	VisualNurbs
	Nurbs (non-uniform rational b-spline) functionality. More...
class	VisualObject
	Basic abstract object data type of core objects. More...
class	VisualObjectData
	VisualObjectData allows incremental data load of visual objects. More...
class	VisualPlayerState
	Provides access to the state of the audio player host. More...
class	VisualPreferences
	Stores preference values of different data type (integer, float, char, boolean). More...
class	VisualSignature
	Collection of static methods for specific data to establish communication with iTunes host application. More...
class	VisualStageBox
	Position and dimensions of a box on stage. More...
class	VisualStageControl
	Singleton mediator that controls the show of the VisualEnsemble. More...
class	VisualStagePosition
	Dimensionless position of asset on stage. More...
class	VisualTextAutoScrollView
	A VisualTextAutoScrollView displays rendered text. More...
class	VisualTextureContainer
	A data container with a reference to an image texture. More...
class	VisualVertex
	A vertex is coord position information, incl. More...
class	CAboutPane
	UI (Windows): Pane with about information. More...
class	COptionsPane
	UI (Windows): Pane with visualizer options. More...
class	CUpdatePane
	UI (Windows): Pane with checkbox for automatic update. More...
class	CVisualPropertySheet
	UI (Windows): Property sheet which contains various panes. More...
Typedefs
typedef void(*	VisualAnimationAnimateCallback )(double currentPosition, void *userData)
	Animation callback.
typedef double	AnimationSpeed
	Speed of animation (measured in number of units per millisecond).
typedef void(*	VisualAnimationPerformAnyAdditionalActionCallback )(VisualAnimationComponent animationComponent, void userData)
	Callback to do any additional action or check for any condition in duration of animation component.
typedef void(*	VisualAnimationWillDieCallback )(VisualAnimationComponent animationComponent, void userData)
	Callback to notify of death of animation component.
typedef const VisualString	ConstVisualString
	Constant VisualString.
typedef uint32	PixelColor
	A pixel color contains ARGB values (alpha, red, green, blue with 8 bits for each color channel).
typedef Point3D	Coord
	A Coord is a three-dimensional point relative to logical coordinate system.
typedef Point3D	RelCoord
	A RelCoord is a relative three-dimensional point in coordinate system.
typedef Point3D	Vector
	A Vector points in a direction.
typedef TexCoord	RelTexCoord
	A RelTexCoord is a coord position of a texture.
typedef uint32	ScalingBehaviour
	ScalingBehaviour is the data type for specifying the scaling behaviour of a texture in combination with margins.
typedef RGBAColor	VertexColor
	Stores the color values used by a vertex.
typedef std::vector < VertexPosition * >	VertexPositionChain
	Chain of vertex positions.
typedef VertexPositionChain *	VertexPositionChainRef
	Pointer to chain of vertex positions.
typedef const VertexPositionChain	ConstVertexPositionChain
	Constant chain of vertex positions.
typedef const VertexPositionChainRef	ConstVertexPositionChainRef
	Pointer to constant chain of vertex positions.
typedef VertexPositionChain::iterator	VertexPositionChainIterator
	Iterator of chain of vertex positions.
typedef ConstVertexPositionChain::iterator	ConstVertexPositionChainIterator
	Iterator of constant chain of vertex positions.
typedef VertexPositionChain::const_iterator	VertexPositionChainConstIterator
	Constant iterator of chain of vertex positions.
typedef ConstVertexPositionChain::const_iterator	ConstVertexPositionChainConstIterator
	Constant iterator of constant chain of vertex positions.
typedef std::vector < VisualVertex * >	VertexChain
	Chain of vertices.
typedef VertexChain *	VertexChainRef
	Pointer to chain of vertices.
typedef const VertexChain	ConstVertexChain
	Constant chain of vertices.
typedef const VertexChainRef	ConstVertexChainRef
	Pointer to constant chain of vertices.
typedef VertexChain::iterator	VertexChainIterator
	Iterator of chain of vertices.
typedef ConstVertexChain::iterator	ConstVertexChainIterator
	Iterator of constant chain of vertices.
typedef VertexChain::const_iterator	VertexChainConstIterator
	Constant iterator of chain of vertices.
typedef ConstVertexChain::const_iterator	ConstVertexChainConstIterator
	Constant iterator of constant chain of vertices.
Enumerations
enum	LoopMode { kNoLoop = 0x0, kLoop = 0x2, kMirroredLoop = 0x3 }
	The type of looping. More...
enum	AnimatedProperty { kUndefinedAnimatedProperty = 0, kCustomAnimatedProperty, kAnimatedSize, kAnimatedLocation, kAnimatedOpacity, kAnimatedRotation }
	The property of the asset that is affected by the animation. More...
enum	InterpolationType { kLinearInterpolation = 0, kSinusoidalInterpolation }
	Types of interpolation between two values. More...
enum	RepeatMode { kRepeatFromStart = 0, kRepeatMirrored }
	The type of repetition. More...
enum	MovingDirection { kAscending = 0, kDescending }
	The internal type of direction. More...
enum	TimelineUpdateResult { kTimelineUpdateOK, kElapsedTimeDidExceedDuration, kStopValueHit, kTimelineIsStopped, kNoDurationTime }
	Possible return values of the update() call. More...
enum	VisualFontActivationResult { fontActivationUndefined = 0, fontActivationNoError, fontActivationFontAlreadyAvailable, fontActivationUnableToActivateFont }
	Return values for explicit font activation. More...
enum	VisualActorState { kVisActUndefinedState = 0, kVisActOff = 1, kVisActOn = 2, kVisActNoShow = 3 }
	The VisualActorState defines the possible state of the VisualActor. More...
enum	Orientation { kPortrait = 0, kLandscape, kSquare }
	Orientation. More...
enum	ScalingBehaviourEnumValues { kNoScaling = 0x1, kScalingAllowed = 0x2, kPreserveAspectRatio = 0x6, kNonproportional = 0xA, kClippingAllowed = 0x10 }
	ScalingBehaviourEnumValues enumerate the possible bit flag values of a ScalingBehaviour. More...
enum	Visibility { kVisible = 0, kInvisible }
	Visibility specifies the visibility. More...
enum	ProjectionMode { kOrthographic = 0, kPerspective }
	ProjectionMode specifies orthographic or perspective projection. More...
enum	SpacePosition { kTopLeft = 0, kBottomLeft, kBottomRight, kTopRight }
	Symbolic names for arbitrary positions in 3-dimensional space. More...
enum	Unit { kPixel = 0, kPercent }
	The measure of box values. More...
enum	HorizontalAlignment { kLeftAligned = 0, kCenterAligned, kRightAligned }
	Types of horizontal alignment. More...
enum	VerticalAlignment { kTopAligned = 0, kMiddleAligned, kBottomAligned }
	Types of vertical alignment. More...
enum	DepthAlignment { kFrontAligned = 0, kDepthCenterAligned, kBackAligned }
	Types of alignment in z-dimension. More...
enum	NurbsDisplayMode { kFill = 0, kOutlinePolygon }
	Whether the Nurbs is displayed in outlined mode or filled. More...
enum	BlendMode { kBlend = 0, kReplace }
	How to blend texture data with the framebuffer data. More...
enum	VisualNotificationKey { kNoNotificationKey = 0, kAudioPlayTrackChangedEvt, kAudioPlayStartedEvt, kAudioPlayStoppedEvt, kAudioPlayPausedEvt, kAudioPlayResumedEvt, kAudioPlayReachedFadeOutTimeEvt, kTrackPlayPositionChangedEvt, kAudioDataMsg, kCanvasReshapeEvt, kBeatImpulseEvt, kTrackInfoImageMsg, kTrackLyricsStringMsg, kTrackLyricsImageMsg, kLoadingEncodedImageDataCompletedMsg, kImageHistogramCompletedMsg, kImageWithIdentifierLoadedAndCreatedMsg, kImageWriteToPNGFileMsg, kImageWriteToPNGFileAndDeleteMsg, kGetTrackInfoStringStyleMsg, kGetTrackLyricsStringStyleMsg, kStyledStringMsg, kStringWithIdentifierLoadedAndCreatedMsg, kLyricsAreWrittenIntoTempFileMsg, kLyricsAreAvailableInMetadataMsg, kTrackInfoTextureChangedMsg, kToggleShowProcessMonitorMsg, AdditionalDispatchedNotificationKeys }
	Constants for various notifications that can be sent to VisualActors or dispatched to individual modules. More...
enum	AudioPlayState { kAudioIsNotPlaying = 0x0, kAudioPlayStarted = 0x3, kAudioIsPlaying = 0x1, kAudioPlayResumed = 0x5, kAudioPlayPaused = 0x2 }
	Constants for different modes of audio play. More...
enum	PlayerShowMode { kIsNotShowing = 0x0, kErrorState = 0x80, kIsShowing = 0x1, kIsShowingInWindow = 0x1, kIsShowingInFullScreen = 0x3 }
	Different modes of showing. More...
Functions
void	convertVisualActorStateToString (const VisualActorState aVisualActorState, char *outString)
	Converts VisualActorState into char string.
Variables
const sint32	kInfiniteRepetition = -1
const Coord	zeroCoord = {0.0, 0.0, 0.0}
	Predefined zero coord (x = 0.0 and y = 0.0).
const VertexColor	black = {0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0}
	Predefined black color.
const VertexColor	white = {1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0}
	Predefined white color.
const VertexColor	red = {1.0, 0.0, 0.0, 1.0, 1.0, 0.0, 0.0, 1.0}
	Predefined red color.
const VertexColor	green = {0.0, 1.0, 0.0, 1.0, 0.0, 1.0, 0.0, 1.0}
	Predefined green color.
const VertexColor	blue = {0.0, 0.0, 1.0, 1.0, 0.0, 0.0, 1.0, 1.0}
	Predefined blue color.
const VertexColor	transparent = {0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0}
	Predefined transparent color.
const int	kGL_POINTS = GL_POINTS
	Primitive GL type GL_POINTS (mode).
const int	kGL_LINES = GL_LINES
	Primitive GL type GL_LINES (mode).
const int	kGL_LINE_STRIP = GL_LINE_STRIP
	Primitive GL type GL_LINE_STRIP (mode).
const int	kGL_LINE_LOOP = GL_LINE_LOOP
	Primitive GL type GL_LINE_LOOP (mode).
const int	kGL_TRIANGLES = GL_TRIANGLES
	Primitive GL type GL_TRIANGLES (mode).
const int	kGL_TRIANGLE_STRIP = GL_TRIANGLE_STRIP
	Primitive GL type GL_TRIANGLE_STRIP (mode).
const int	kGL_TRIANGLE_FAN = GL_TRIANGLE_FAN
	Primitive GL type GL_TRIANGLE_FAN (mode).
const int	kGL_QUADS = GL_QUADS
	Primitive GL type GL_QUADS (mode).
const int	kGL_QUAD_STRIP = GL_QUAD_STRIP
	Primitive GL type GL_QUAD_STRIP (mode).
const int	kGL_POLYGON = GL_POLYGON
	Primitive GL type GL_POLYGON (mode).
const int	kGL_RGBA = GL_RGBA
	Primitive GL type GL_RGBA (format).
const int	kGL_BGRA = GL_BGRA_EXT
	Primitive GL type GL_BGRA (format).
const int	kGL_RGB = GL_RGB
	Primitive GL type GL_RGB (format).
const int	kGL_LUMINANCE = GL_LUMINANCE
	Primitive GL type GL_LUMINANCE (format).
const int	kGL_LUMINANCE_WITH_ALPHA = GL_LUMINANCE_ALPHA
	Primitive GL type GL_LUMINANCE_ALPHA (format).
const int	kGL_INTENSITY = GL_INTENSITY
	Primitive GL type GL_INTENSITY (format).
const int	kGL_UNSIGNED_BYTE = GL_UNSIGNED_BYTE
	Primitive GL type GL_UNSIGNED_BYTE (data type).
const int	kGL_FLOAT = GL_FLOAT
	Primitive GL type GL_FLOAT (data type).
const int	kGL_UNSIGNED_INT_8_8_8_8_REV = GL_UNSIGNED_INT_8_8_8_8_REV
	Primitive GL type GL_UNSIGNED_INT_8_8_8_8_REV (data type).
const int	kGL_UNSIGNED_INT_8_8_8_8 = GL_UNSIGNED_INT_8_8_8_8
	Primitive GL type GL_UNSIGNED_INT_8_8_8_8 (data type).
const int	kGL_FRONT_COLOR_BUFFER = GL_FRONT
	GL enum GL_FRONT (color buffer specification for reading or drawing pixels).
const int	kGL_BACK_COLOR_BUFFER = GL_BACK
	GL enum GL_BACK (color buffer specification for reading or drawing pixels).

Typedef Documentation

typedef double VizKit::AnimationSpeed

Speed of animation (measured in number of units per millisecond).

typedef const VertexChain VizKit::ConstVertexChain

Constant chain of vertices.

typedef ConstVertexChain::const_iterator VizKit::ConstVertexChainConstIterator

Constant iterator of constant chain of vertices.

typedef ConstVertexChain::iterator VizKit::ConstVertexChainIterator

Iterator of constant chain of vertices.

typedef const VertexChainRef VizKit::ConstVertexChainRef

Pointer to constant chain of vertices.

typedef const VertexPositionChain VizKit::ConstVertexPositionChain

Constant chain of vertex positions.

typedef ConstVertexPositionChain::const_iterator VizKit::ConstVertexPositionChainConstIterator

Constant iterator of constant chain of vertex positions.

typedef ConstVertexPositionChain::iterator VizKit::ConstVertexPositionChainIterator

Iterator of constant chain of vertex positions.

typedef const VertexPositionChainRef VizKit::ConstVertexPositionChainRef

Pointer to constant chain of vertex positions.

typedef const VisualString VizKit::ConstVisualString

Constant VisualString.

typedef Point3D VizKit::Coord

A Coord is a three-dimensional point relative to logical coordinate system.

typedef uint32 VizKit::PixelColor

A pixel color contains ARGB values (alpha, red, green, blue with 8 bits for each color channel).

typedef Point3D VizKit::RelCoord

A RelCoord is a relative three-dimensional point in coordinate system.

x: 0.0 means: left, 1.0 means: right; y: 0.0 means: bottom, 1.0 means: top; z: 0.0 means: front, 1.0 means: back.

typedef TexCoord VizKit::RelTexCoord

A RelTexCoord is a coord position of a texture.

s: 0.0 means: left, 1.0 means: right; t: 0.0 means: bottom, 1.0 means: top.

typedef uint32 VizKit::ScalingBehaviour

ScalingBehaviour is the data type for specifying the scaling behaviour of a texture in combination with margins.

typedef Point3D VizKit::Vector

A Vector points in a direction.

typedef std::vector<VisualVertex*> VizKit::VertexChain

Chain of vertices.

typedef VertexChain::const_iterator VizKit::VertexChainConstIterator

Constant iterator of chain of vertices.

typedef VertexChain::iterator VizKit::VertexChainIterator

Iterator of chain of vertices.

typedef VertexChain* VizKit::VertexChainRef

Pointer to chain of vertices.

typedef RGBAColor VizKit::VertexColor

Stores the color values used by a vertex.

typedef std::vector<VertexPosition*> VizKit::VertexPositionChain

Chain of vertex positions.

typedef VertexPositionChain::const_iterator VizKit::VertexPositionChainConstIterator

Constant iterator of chain of vertex positions.

typedef VertexPositionChain::iterator VizKit::VertexPositionChainIterator

Iterator of chain of vertex positions.

typedef VertexPositionChain* VizKit::VertexPositionChainRef

Pointer to chain of vertex positions.

typedef void(* VizKit::VisualAnimationAnimateCallback)(double currentPosition, void *userData)

Animation callback.

typedef void(* VizKit::VisualAnimationPerformAnyAdditionalActionCallback)(VisualAnimationComponent *animationComponent, void *userData)

Callback to do any additional action or check for any condition in duration of animation component.

typedef void(* VizKit::VisualAnimationWillDieCallback)(VisualAnimationComponent *animationComponent, void *userData)

Callback to notify of death of animation component.

Enumeration Type Documentation

enum VizKit::AnimatedProperty

The property of the asset that is affected by the animation.

Enumerator:

kUndefinedAnimatedProperty	No defined value.
kCustomAnimatedProperty	Custom property is animated.
kAnimatedSize	The animation affects the size of the asset.
kAnimatedLocation	The animation affects the location of the asset.
kAnimatedOpacity	The animation affects the opacity of the asset.
kAnimatedRotation	The animation affects the rotation of the asset.

enum VizKit::AudioPlayState

Constants for different modes of audio play.

Remarks:: To query whether audio is playing or not, AudioPlayState can be bitwise AND'ed with kAudioIsPlaying.

Enumerator:

kAudioIsNotPlaying	00000000 - No audio is playing.
kAudioPlayStarted	00000011 - Audio started playing.
kAudioIsPlaying	00000001 - Audio is playing.
kAudioPlayResumed	00000101 - Audio play resumed after pause.
kAudioPlayPaused	00000010 - Audio play is pausing.

enum VizKit::BlendMode

How to blend texture data with the framebuffer data.

Enumerator:

kBlend	Blend with framebuffer data (glBlendFunc(GL_ONE, GL_ONE_MINUS_SRC_ALPHA).
kReplace	Replace framebuffer data.

enum VizKit::DepthAlignment

Types of alignment in z-dimension.

Enumerator:

kFrontAligned	Front alignment.
kDepthCenterAligned	Centered alignment.
kBackAligned	Back alignment.

enum VizKit::HorizontalAlignment

Types of horizontal alignment.

Enumerator:

kLeftAligned	Left alignment.
kCenterAligned	Centered alignment.
kRightAligned	Right alignment.

enum VizKit::InterpolationType

Types of interpolation between two values.

Enumerator:

kLinearInterpolation	Linear interpolation.
kSinusoidalInterpolation	Sinusoidal interpolation.

enum VizKit::LoopMode

The type of looping.

Enumerator:

kNoLoop

00000000 - After the duration of the timeline has been reached, the animation stops.

kLoop

00000010 - After the duration of the timeline has been reached, the timeline starts anew at the start.

The timeline is always processed in forward direction.

kMirroredLoop

00000011 - After the duration of the timeline has been reached, the timeline is processed in backward direction.

The moving direction toggles in mirrored loop.

enum VizKit::MovingDirection

The internal type of direction.

Enumerator:

kAscending	The timeline is processed from lower values to higher values.
kDescending	The timeline is processed from higher values to lower values.

enum VizKit::NurbsDisplayMode

Whether the Nurbs is displayed in outlined mode or filled.

Enumerator:

kFill	Fill Nurbs.
kOutlinePolygon	Draw outline.

enum VizKit::Orientation

Orientation.

Enumerator:

kPortrait
kLandscape
kSquare

enum VizKit::PlayerShowMode

Different modes of showing.

Used by var showMode of VisualPlayerState.

Remarks:: To query whether the visualizer is showing or not, PlayerShowMode can be bitwise AND'ed with kIsShowing.

Enumerator:

kIsNotShowing	00000000 - Default; the visualizer is not showing.
kErrorState	10000000 - The visualizer is in error state. Therefore it is showing an error message or nothing.
kIsShowing	00000001 - The visualizer is showing.
kIsShowingInWindow	00000001 - The visualizer is showing. And it is showing in a window.
kIsShowingInFullScreen	00000011 - The visualizer is showing. And it is showing fullscreen.

enum VizKit::ProjectionMode

ProjectionMode specifies orthographic or perspective projection.

Enumerator:

kOrthographic
kPerspective

enum VizKit::RepeatMode

The type of repetition.

Enumerator:

kRepeatFromStart

After the duration of the timeline has been reached, the timeline starts anew at the start.

The timeline is always processed in forward direction.

kRepeatMirrored

After the duration of the timeline has been reached, the timeline is processed in backward direction.

The moving direction toggles in mirrored loop.

enum VizKit::ScalingBehaviourEnumValues

ScalingBehaviourEnumValues enumerate the possible bit flag values of a ScalingBehaviour.

Enumerator:

kNoScaling
kScalingAllowed
kPreserveAspectRatio
kNonproportional
kClippingAllowed

enum VizKit::SpacePosition

Symbolic names for arbitrary positions in 3-dimensional space.

Enumerator:

kTopLeft
kBottomLeft
kBottomRight
kTopRight

enum VizKit::TimelineUpdateResult

Possible return values of the update() call.

Enumerator:

kTimelineUpdateOK	No error, no special state.
kElapsedTimeDidExceedDuration	The elapsed time exceeded the set duration time.
kStopValueHit	The set stop value is hit or crossed (depending on the current move direction).
kTimelineIsStopped	The VisualTimeline is stopped.
kNoDurationTime	The amount of the duration time is 0.

enum VizKit::Unit

The measure of box values.

Enumerator:

kPixel	Box attribute is measured in pixels.
kPercent	Box attribute is measured in percent (of enclosing/surrounding VisualStageBox).

enum VizKit::VerticalAlignment

Types of vertical alignment.

Enumerator:

kTopAligned	Top alignment.
kMiddleAligned	Middle alignment.
kBottomAligned	Bottom alignment.

enum VizKit::Visibility

Visibility specifies the visibility.

Two states are possible: visible and invisible.

Enumerator:

kVisible
kInvisible

enum VizKit::VisualActorState

The VisualActorState defines the possible state of the VisualActor.

Enumerator:

kVisActUndefinedState	Undefined state that e.g. can be used to check against previous state with initialization state.
kVisActOff	The actor is turned off. The actor is called during the show nevertheless. The actor can decide if it wants to display anything.
kVisActOn	The actor is turned on.
kVisActNoShow	The actor is turned off. The actor is not called during the show at all. Therefore the actor can not be turned on by ensemble.

enum VizKit::VisualFontActivationResult

Return values for explicit font activation.

Enumerator:

fontActivationUndefined	Undefined state.
fontActivationNoError	No error.
fontActivationFontAlreadyAvailable	The font was already available (no activation of the font resource has been necessary).
fontActivationUnableToActivateFont	Unable to activate font.

enum VizKit::VisualNotificationKey

Constants for various notifications that can be sent to VisualActors or dispatched to individual modules.

Enumerator:

kNoNotificationKey	No defined notification.
kAudioPlayTrackChangedEvt	Audio track did change.
kAudioPlayStartedEvt	Audio play started (without changing audio track).
kAudioPlayStoppedEvt	Audio play stopped.
kAudioPlayPausedEvt	Audio play paused. The current audio track did not play until its end.
kAudioPlayResumedEvt	Audio play resumed. After pause play resumed.
kAudioPlayReachedFadeOutTimeEvt	The remaining time of the audio track is shorter than kFadeOutTimeBeforeEndOfTrackInMS.
kTrackPlayPositionChangedEvt	The play position of the current track did change.
kAudioDataMsg	The audio data as passed in via pulse message.
kCanvasReshapeEvt	The dimensions of the canvas changed.
kBeatImpulseEvt	A beat impulse has been detected.
kTrackInfoImageMsg	The texture of the track info string is available.
kTrackLyricsStringMsg	The string of the track lyrics is available.
kTrackLyricsImageMsg	The texture of the track lyrics string is available.
kLoadingEncodedImageDataCompletedMsg	Loading of image data completed.
kImageHistogramCompletedMsg	A histogram of an image is available.
kImageWithIdentifierLoadedAndCreatedMsg	Loading and creation of image completed.
kImageWriteToPNGFileMsg	An image is supposed to be written as PNG file on disk.
kImageWriteToPNGFileAndDeleteMsg	An image is supposed to be written as PNG file on disk, with the VisualImage object being deleted afterwards.
kGetTrackInfoStringStyleMsg	Evaluate the string style of the track info string.
kGetTrackLyricsStringStyleMsg	Evaluate the string style of the lyics string.
kStyledStringMsg	A styled string is available.
kStringWithIdentifierLoadedAndCreatedMsg	Loading and creation of string completed.
kLyricsAreWrittenIntoTempFileMsg	Lyrics are written into temp file (internal notification, not for actors).
kLyricsAreAvailableInMetadataMsg	Lyrics of the current audio track are available.
kTrackInfoTextureChangedMsg	The texture of the track info changed.
kToggleShowProcessMonitorMsg	The ProcessMonitor values should be shown if they are hidden or hidden if they are shown.
AdditionalDispatchedNotificationKeys	The audio data of the ProcessMonitor should be shown if it is hidden or hidden if it is shown.

Function Documentation

void VizKit::convertVisualActorStateToString	(	const VisualActorState	aVisualActorState,
		char *	outString
	)

Converts VisualActorState into char string.

Possibly useful for debugging or tracing purposes.

Parameters:

aVisualActorState	The state to convert.
outString	The char string that can be printed and used for debugging output.

Variable Documentation

const VizKit::VertexColor VizKit::black = {0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0}

Predefined black color.

const VizKit::VertexColor VizKit::blue = {0.0, 0.0, 1.0, 1.0, 0.0, 0.0, 1.0, 1.0}

Predefined blue color.

const VizKit::VertexColor VizKit::green = {0.0, 1.0, 0.0, 1.0, 0.0, 1.0, 0.0, 1.0}

Predefined green color.

const int VizKit::kGL_BACK_COLOR_BUFFER = GL_BACK

GL enum GL_BACK (color buffer specification for reading or drawing pixels).

const int VizKit::kGL_BGRA = GL_BGRA_EXT

Primitive GL type GL_BGRA (format).

const int VizKit::kGL_FLOAT = GL_FLOAT

Primitive GL type GL_FLOAT (data type).

const int VizKit::kGL_FRONT_COLOR_BUFFER = GL_FRONT

GL enum GL_FRONT (color buffer specification for reading or drawing pixels).

const int VizKit::kGL_INTENSITY = GL_INTENSITY

Primitive GL type GL_INTENSITY (format).

const int VizKit::kGL_LINE_LOOP = GL_LINE_LOOP

Primitive GL type GL_LINE_LOOP (mode).

const int VizKit::kGL_LINE_STRIP = GL_LINE_STRIP

Primitive GL type GL_LINE_STRIP (mode).

const int VizKit::kGL_LINES = GL_LINES

Primitive GL type GL_LINES (mode).

const int VizKit::kGL_LUMINANCE = GL_LUMINANCE

Primitive GL type GL_LUMINANCE (format).

const int VizKit::kGL_LUMINANCE_WITH_ALPHA = GL_LUMINANCE_ALPHA

Primitive GL type GL_LUMINANCE_ALPHA (format).

const int VizKit::kGL_POINTS = GL_POINTS

Primitive GL type GL_POINTS (mode).

const int VizKit::kGL_POLYGON = GL_POLYGON

Primitive GL type GL_POLYGON (mode).

const int VizKit::kGL_QUAD_STRIP = GL_QUAD_STRIP

Primitive GL type GL_QUAD_STRIP (mode).

const int VizKit::kGL_QUADS = GL_QUADS

Primitive GL type GL_QUADS (mode).

const int VizKit::kGL_RGB = GL_RGB

Primitive GL type GL_RGB (format).

const int VizKit::kGL_RGBA = GL_RGBA

Primitive GL type GL_RGBA (format).

const int VizKit::kGL_TRIANGLE_FAN = GL_TRIANGLE_FAN

Primitive GL type GL_TRIANGLE_FAN (mode).

const int VizKit::kGL_TRIANGLE_STRIP = GL_TRIANGLE_STRIP

Primitive GL type GL_TRIANGLE_STRIP (mode).

const int VizKit::kGL_TRIANGLES = GL_TRIANGLES

Primitive GL type GL_TRIANGLES (mode).

const int VizKit::kGL_UNSIGNED_BYTE = GL_UNSIGNED_BYTE

Primitive GL type GL_UNSIGNED_BYTE (data type).

const int VizKit::kGL_UNSIGNED_INT_8_8_8_8 = GL_UNSIGNED_INT_8_8_8_8

Primitive GL type GL_UNSIGNED_INT_8_8_8_8 (data type).

const int VizKit::kGL_UNSIGNED_INT_8_8_8_8_REV = GL_UNSIGNED_INT_8_8_8_8_REV

Primitive GL type GL_UNSIGNED_INT_8_8_8_8_REV (data type).

const sint32 VizKit::kInfiniteRepetition = -1

const VizKit::VertexColor VizKit::red = {1.0, 0.0, 0.0, 1.0, 1.0, 0.0, 0.0, 1.0}

Predefined red color.

const VizKit::VertexColor VizKit::transparent = {0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0}

Predefined transparent color.

const VizKit::VertexColor VizKit::white = {1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0}

Predefined white color.

const VizKit::Coord VizKit::zeroCoord = {0.0, 0.0, 0.0}

Predefined zero coord (x = 0.0 and y = 0.0).

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation