Public Member Functions | Public Attributes

FBVideoClip Class Reference

Search for all occurrences

Detailed Description

Definition at line 182 of file fbvideo.h.

#include <fbvideo.h>

Inheritance diagram for FBVideoClip:
Inheritance graph
[legend]

List of all members.

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:
pNameName of video media.
pObjectInternal 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]

Open Reality deletion function.

Reimplemented from FBComponent.

bool IsValid ( )

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]

Draw a frame of the image to the current view.

Parameters:
pXX position of image (default=0).
pYY position of image (default=0).
pWWidth of image (default=-1).
pHHeight of image (default=-1).
pFrameFrame to draw (default=-1).
virtual unsigned char* GetImage ( int  pFrame = -1) [virtual]

Get the current image buffer.

Parameters:
pFrameFrame to get image for (default=-1).
Returns:
Handle to the image buffer specified by the pFrame parameter.
virtual void ImageIncUpdateID ( ) [virtual]

Increase Image update id after modification to trigger internal state refresh.

virtual unsigned char* GetPowerOfTwoImage ( ) [virtual]

Get the current image buffer resized with width and height power of two.

Returns:
Handle to the image buffer specified by the pFrame parameter.
int GetTextureID ( )

Get the texture ID.

Returns:
ID of the texture

Member Data Documentation

Read Write Property: Filename of media.

Definition at line 202 of file fbvideo.h.

Read Only Property: Relative path of media.

Definition at line 203 of file fbvideo.h.

FBPropertyVideoProxyMode ProxyMode

Read Write Property: Proxy mode.

Definition at line 204 of file fbvideo.h.

FBPropertyVideoStorageMode StorageMode

Read Write Property: Storage mode.

Definition at line 205 of file fbvideo.h.

Read Only Property: Width of image.

Definition at line 206 of file fbvideo.h.

Read Only Property: Height of image.

Definition at line 207 of file fbvideo.h.

Read Only Property: Closest power of two value superior to width of image.

Definition at line 208 of file fbvideo.h.

Read Only Property: Closest power of two value superior to height of image.

Definition at line 209 of file fbvideo.h.

FBPropertyVideoInterlaceMode InterlaceMode

Read Write Property: Interlace mode.

Definition at line 210 of file fbvideo.h.

FBPropertyVideoFormat Format

Read Only Property: Video format.

Definition at line 211 of file fbvideo.h.

Read Write Property: Temporal offset for beginning of video.

Definition at line 214 of file fbvideo.h.

Read Write Property: Frame to begin video playback from.

Definition at line 215 of file fbvideo.h.

Read Write Property: Frame to end video playback at.

Definition at line 216 of file fbvideo.h.

Read Write Property: Frame rate.

Definition at line 217 of file fbvideo.h.

Read Write Property: Playback speed.

Definition at line 218 of file fbvideo.h.

Read Write Property: Is free Running on?

Definition at line 219 of file fbvideo.h.

Read Write Property: Loop video clip?

Definition at line 220 of file fbvideo.h.

Read Only Property: Inverse of FPS, time per frame

Definition at line 222 of file fbvideo.h.

Read Write Property: Current frame.

Definition at line 223 of file fbvideo.h.

Read Only Property: Last frame in clip.

Definition at line 224 of file fbvideo.h.

Read Only Property: Time of last frame

Definition at line 225 of file fbvideo.h.

Read Write Property: Current time in clip.

Definition at line 226 of file fbvideo.h.


The documentation for this class was generated from the following file:

FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip
FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip