FBVideoClip Class Reference

FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip
Inheritance diagram for FBVideoClip:
Inheritance graph
[legend]

List of all members.


Detailed Description

Definition at line 157 of file fbvideo.h.


Public Member Functions

  FBVideoClip (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 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 walue superior to width of image.
FBPropertyInt  PowerOfTwoHeight
  Read Only Property: Closest power of two walue 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  FPS
  Read Only 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 ( 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]

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:
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).

virtual unsigned char* GetImage ( int  pFrame = -1  )  [virtual]

Get the current image buffer.

Parameters:
pFrame  Frame to get image for (default=-1).
Returns:
Handle to the image buffer specified by the pFrame parameter.

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

FBPropertyString Filename

Read Write Property: Filename of media.

Definition at line 177 of file fbvideo.h.

FBPropertyString RelativePath

Read Only Property: Relative path of media.

Definition at line 178 of file fbvideo.h.

FBPropertyVideoProxyMode ProxyMode

Read Write Property: Proxy mode.

Definition at line 179 of file fbvideo.h.

FBPropertyVideoStorageMode StorageMode

Read Write Property: Storage mode.

Definition at line 180 of file fbvideo.h.

FBPropertyInt Width

Read Only Property: Width of image.

Definition at line 181 of file fbvideo.h.

FBPropertyInt Height

Read Only Property: Height of image.

Definition at line 182 of file fbvideo.h.

FBPropertyInt PowerOfTwoWidth

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

Definition at line 183 of file fbvideo.h.

FBPropertyInt PowerOfTwoHeight

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

Definition at line 184 of file fbvideo.h.

FBPropertyVideoInterlaceMode InterlaceMode

Read Write Property: Interlace mode.

Definition at line 185 of file fbvideo.h.

FBPropertyVideoFormat Format

Read Only Property: Video format.

Definition at line 186 of file fbvideo.h.

FBPropertyTime TimeOffset

Read Write Property: Temporal offset for beginning of video.

Definition at line 189 of file fbvideo.h.

FBPropertyInt StartFrame

Read Write Property: Frame to begin video playback from.

Definition at line 190 of file fbvideo.h.

FBPropertyInt StopFrame

Read Write Property: Frame to end video playback at.

Definition at line 191 of file fbvideo.h.

FBPropertyDouble FPS

Read Only Property: Frame rate.

Definition at line 192 of file fbvideo.h.

FBPropertyDouble PlaySpeed

Read Write Property: Playback speed.

Definition at line 193 of file fbvideo.h.

FBPropertyBool FreeRunning

Read Write Property: Is free Running on?

Definition at line 194 of file fbvideo.h.

FBPropertyBool Loop

Read Write Property: Loop video clip?

Definition at line 195 of file fbvideo.h.

FBPropertyTime FrameTime

Read Only Property: Inverse of FPS, time per frame

Definition at line 197 of file fbvideo.h.

FBPropertyInt CurrentFrame

Read Write Property: Current frame.

Definition at line 198 of file fbvideo.h.

FBPropertyInt LastFrame

Read Only Property: Last frame in clip.

Definition at line 199 of file fbvideo.h.

FBPropertyTime LastFrameTime

Read Only Property: Time of last frame

Definition at line 200 of file fbvideo.h.

FBPropertyTime CurrentFrameTime

Read Write Property: Current time in clip.

Definition at line 201 of file fbvideo.h.


Please send us your comments about this page.