Detailed Description

Definition at line 182 of file fbvideo.h.

#include <fbvideo.h>

Inheritance diagram for FBVideoClip:

Public Member Functions
	FBVideoClip (const char *pName, HIObject pObject=NULL)
	Constructor.
virtual void	FBDelete ()
	Open Reality deletion function.
bool	IsValid ()
	Verifies the validity of the FBVideo object.
virtual void	DrawImage (int pX=0, int pY=0, int pW=-1, int pH=-1, int pFrame=-1)
	Draw a frame of the image to the current view.
virtual unsigned char *	GetImage (int pFrame=-1)
	Get the current image buffer.
virtual void	ImageIncUpdateID ()
	Increase Image update id after modification to trigger internal state refresh.
virtual unsigned char *	GetPowerOfTwoImage ()
	Get the current image buffer resized with width and height power of two.
int	GetTextureID ()
	Get the texture ID.
Public Attributes
FBPropertyString	Filename
	Read Write Property: Filename of media.
FBPropertyString	RelativePath
	Read Only Property: Relative path of media.
FBPropertyVideoProxyMode	ProxyMode
	Read Write Property: Proxy mode.
FBPropertyVideoStorageMode	StorageMode
	Read Write Property: Storage mode.
FBPropertyInt	Width
	Read Only Property: Width of image.
FBPropertyInt	Height
	Read Only Property: Height of image.
FBPropertyInt	PowerOfTwoWidth
	Read Only Property: Closest power of two value superior to width of image.
FBPropertyInt	PowerOfTwoHeight
	Read Only Property: Closest power of two value superior to height of image.
FBPropertyVideoInterlaceMode	InterlaceMode
	Read Write Property: Interlace mode.
FBPropertyVideoFormat	Format
	Read Only Property: Video format.
FBPropertyTime	TimeOffset
	Read Write Property: Temporal offset for beginning of video.
FBPropertyInt	StartFrame
	Read Write Property: Frame to begin video playback from.
FBPropertyInt	StopFrame
	Read Write Property: Frame to end video playback at.
FBPropertyDouble	FrameRate
	Read Write Property: Frame rate.
FBPropertyDouble	PlaySpeed
	Read Write Property: Playback speed.
FBPropertyBool	FreeRunning
	Read Write Property: Is free Running on?
FBPropertyBool	Loop
	Read Write Property: Loop video clip?
FBPropertyTime	FrameTime
	Read Only Property: Inverse of FPS, time per frame
FBPropertyInt	CurrentFrame
	Read Write Property: Current frame.
FBPropertyInt	LastFrame
	Read Only Property: Last frame in clip.
FBPropertyTime	LastFrameTime
	Read Only Property: Time of last frame
FBPropertyTime	CurrentFrameTime
	Read Write Property: Current time in clip.

Constructor & Destructor Documentation

FBVideoClip	(	const char *	pName,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters:

pName	Name of video media.
pObject	Internal parent object(default=NULL).

Warning:: The pName parameter must point to a valid media file, otherwise the object will not be valid. Use the method 'IsValid()' to confirm the object status.

Member Function Documentation

virtual void FBDelete ( ) [virtual]

Search for all occurrences

Open Reality deletion function.

Reimplemented from FBComponent.

bool IsValid ( )

Search for all occurrences

Verifies the validity of the FBVideo object.

Returns:: true if data is valid.

virtual void DrawImage	(	int	pX = `0`,
		int	pY = `0`,
		int	pW = `-1`,
		int	pH = `-1`,
		int	pFrame = `-1`
	)		`[virtual]`

Search for all occurrences

Draw a frame of the image to the current view.

Parameters:

pX	X position of image (default=0).
pY	Y position of image (default=0).
pW	Width of image (default=-1).
pH	Height of image (default=-1).
pFrame	Frame to draw (default=-1).