This reference page is linked to from the following overview topics: List of Python Fbx classes.
Detailed Description
FBX SDK video class.
Definition at line 29 of file fbxvideo.h.
#include <fbxvideo.h>
Public Types |
|
| enum | EInterlaceMode
{ eNone, eFields, eHalfEven, eHalfOdd, eFullEven, eFullOdd, eFullEvenOdd, eFullOddEven } |
|
Video interlace modes. More... |
|
| enum | EAccessMode { eDisk, eMemory, eDiskAsync } |
|
Video clip access mode. More... |
|
Public Member Functions |
|
| double | GetFrameRate () const |
| Retrieve the Frame rate of the video clip.
|
|
| int | GetLastFrame () const |
| Retrieve the last frame of the video clip.
|
|
| int | GetWidth () const |
| Retrieve the clip width. |
|
| int | GetHeight () const |
| Retrieve the clip height. |
|
| void | SetStartFrame (int pStartFrame) |
| Set the start frame of the video clip.
|
|
| int | GetStartFrame () const |
| Retrieve the start frame of the video clip.
|
|
| void | SetStopFrame (int pStopFrame) |
| Set the stop frame of the video clip.
|
|
| int | GetStopFrame () const |
| Retrieve the stop frame of the video clip.
|
|
| void | SetPlaySpeed (double pPlaySpeed) |
| Set the play speed of the video clip.
|
|
| double | GetPlaySpeed () const |
| Retrieve the play speed of the video clip.
|
|
| void | SetOffset (FbxTime pTime) |
| Set the time offset. |
|
| FbxTime | GetOffset () const |
| void | SetFreeRunning (bool pState) |
| Set the Free Running state of the video
clip. |
|
| bool | GetFreeRunning () const |
| Retrieve the Free Running state. |
|
| void | SetLoop (bool pLoop) |
| Set the Loop state of the video clip.
|
|
| bool | GetLoop () const |
| Retrieve the Loop state. |
|
| void | SetInterlaceMode (EInterlaceMode pInterlaceMode) |
| Set the Interlace mode. |
|
| EInterlaceMode | GetInterlaceMode () const |
| Retrieve the Interlace mode. |
|
| void | SetAccessMode (EAccessMode pAccessMode) |
| Set the clip Access Mode. |
|
| EAccessMode | GetAccessMode () const |
| Retrieve the clip Access Mode. |
|
| virtual FbxObject & | Copy (const FbxObject &pObject) |
| Copy an object content into this object.
|
|
| virtual FbxStringList | GetTypeFlags () const |
| void | SetOriginalFormat (bool pState) |
| bool | GetOriginalFormat () const |
| void | SetOriginalFilename (const char *pOriginalFilename) |
| const char * | GetOriginalFilename () const |
Public Attributes |
|
| FbxPropertyT< FbxBool > | ImageSequence |
| FbxPropertyT< FbxInt > | ImageSequenceOffset |
| FbxPropertyT< FbxDouble > | FrameRate |
| FbxPropertyT< FbxInt > | LastFrame |
| FbxPropertyT< FbxInt > | Width |
| FbxPropertyT< FbxInt > | Height |
| FbxPropertyT< FbxString > | Path |
| FbxPropertyT< FbxInt > | StartFrame |
| FbxPropertyT< FbxInt > | StopFrame |
| FbxPropertyT< FbxDouble > | PlaySpeed |
| FbxPropertyT< FbxTime > | Offset |
| FbxPropertyT< EInterlaceMode > | InterlaceMode |
| FbxPropertyT< FbxBool > | FreeRunning |
| FbxPropertyT< FbxBool > | Loop |
| FbxPropertyT< EAccessMode > | AccessMode |
Protected Member Functions |
|
| FbxVideo (FbxManager &pManager, char const *pName) | |
| virtual void | Construct (const FbxVideo *pFrom) |
| virtual bool | ConstructProperties (bool pForceSet) |
| virtual bool | ConnecNotify (FbxConnectEvent const &pEvent) |
| void | Init () |
Protected Attributes |
|
| bool | mUseMipMap |
| bool | mOriginalFormat |
| FbxString | mOriginalFilename |
| FbxString | mRelativeFilename |
Static Protected Attributes |
|
| static FbxError | smError |
Reset video |
|
| void | Reset () |
| Reset the video to default values. |
|
Video attributes Management |
|
| void | ImageTextureSetMipMap (bool pUseMipMap) |
| Set the use of MipMap on the video. |
|
| bool | ImageTextureGetMipMap () const |
| Retrieve use MipMap state. |
|
| bool | SetFileName (char const *pName) |
| Specify the Video full filename. |
|
| FbxString | GetFileName () const |
| Retrieve the Video full filename. |
|
| bool | SetRelativeFileName (char const *pName) |
| Specify the Video relative filename.
|
|
| const char * | GetRelativeFileName () const |
| Retrieve the Video relative filename.
|
|
Image sequence attributes Management |
|
| Besides storing video
clips, the FbxVideo object can also store image
sequences.This section contains the manipulation methods used in
this specialized mode. Note that, except for the GetFileName(),
SetFileName(), GetRelativeFileName(),
SetRelativeFileName()
and the methods in this section, all the other ones are not
mandatory therefore could contain uninitialized or default data
values. |
|
| void | SetImageSequence (bool pImageSequence) |
| Specify if this video object is holding the
starting point of an image sequence. |
|
| bool | GetImageSequence () const |
| Get the current state of the ImageSequence
property. |
|
| void | SetImageSequenceOffset (int pOffset) |
| Specify the frame offset to be applied to
the image sequence. |
|
| int | GetImageSequenceOffset () const |
| Get the current value of the
ImageSequenceOffset property. |
|
Error Management |
|
| enum | EErrorCode { eTakeNodeError, eErrorCount } |
|
Error identifiers. More... |
|
| FbxError & | GetError () |
| Retrieve error object. |
|
| EErrorCode | GetLastErrorID () const |
| Get last error code. |
|
| const char * | GetLastErrorString () const |
| Get last error string. |
|
Member Enumeration Documentation
| enum EInterlaceMode |
Video interlace modes.
- Enumerator:
Definition at line 207 of file fbxvideo.h.
{
eNone,
eFields,
eHalfEven,
eHalfOdd,
eFullEven,
eFullOdd,
eFullEvenOdd,
eFullOddEven
};
| enum EAccessMode |
| enum EErrorCode |
Constructor & Destructor Documentation
| FbxVideo | ( | FbxManager & | pManager, |
| char const * | pName | ||
| ) | [protected] |
Member Function Documentation
| void Reset | ( | ) |
Reset the video to default values.
| void ImageTextureSetMipMap | ( | bool | pUseMipMap | ) |
Set the use of MipMap on the video.
- Parameters:
-
pUseMipMap If true, use MipMap on the video.
| bool ImageTextureGetMipMap | ( | ) | const |
| bool SetFileName | ( | char const * | pName | ) |
Specify the Video full filename.
- Parameters:
-
pName Video full filename.
- Returns:
True,if update successfully,falseotherwise.
- Remarks:
- Update the texture filename if the connection exists.
| FbxString GetFileName | ( | ) | const |
| bool SetRelativeFileName | ( | char const * | pName | ) |
Specify the Video relative filename.
- Parameters:
-
pName Video relative filename.
- Returns:
True, if update successfully,falseotherwise.
- Remarks:
- Update the texture filename if the connection exists.
| const char* GetRelativeFileName | ( | ) | const |
| void SetImageSequence | ( | bool | pImageSequence | ) |
Specify if this video object is holding the starting point of an image sequence.
- Parameters:
-
pImageSequence If true, this object is holding an image sequence.
- Remarks:
- When this object is used as image sequence, the FBX SDK will automatically exclude it from the embedding mechanism.
| bool GetImageSequence | ( | ) | const |
Get the current state of the ImageSequence property.
- Returns:
- ImageSequence property value.
| void SetImageSequenceOffset | ( | int | pOffset | ) |
Specify the frame offset to be applied to the image sequence.
- Parameters:
-
pOffset The frame offset value.
| int GetImageSequenceOffset | ( | ) | const |
Get the current value of the ImageSequenceOffset property.
- Returns:
- ImageSequenceOffset property value.
| double GetFrameRate | ( | ) | const |
| int GetLastFrame | ( | ) | const |
| int GetWidth | ( | ) | const |
| int GetHeight | ( | ) | const |
| void SetStartFrame | ( | int | pStartFrame | ) |
Set the start frame of the video clip.
- Parameters:
-
pStartFrame Start frame number.
- Remarks:
- The parameter value is not checked. It is the responsibility of the caller to deal with bad frame numbers.
| int GetStartFrame | ( | ) | const |
| void SetStopFrame | ( | int | pStopFrame | ) |
Set the stop frame of the video clip.
- Parameters:
-
pStopFrame Stop frame number.
- Remarks:
- The parameter value is not checked. It is the responsibility of the caller to deal with bad frame numbers.
| int GetStopFrame | ( | ) | const |
| void SetPlaySpeed | ( | double | pPlaySpeed | ) |
Set the play speed of the video clip.
- Parameters:
-
pPlaySpeed Playback speed of the clip.
- Remarks:
- The parameter value is not checked. It is the responsibility of the caller to deal with bad playback speed values.
| double GetPlaySpeed | ( | ) | const |
| void SetOffset | ( | FbxTime | pTime | ) |
Set the time offset.
The offset can be used to shift the playback start time of the clip.
- Parameters:
-
pTime Time offset of the clip.
| FbxTime GetOffset | ( | ) | const |
| void SetFreeRunning | ( | bool | pState | ) |
Set the Free Running state of the video clip.
The Free Running flag can be used by a client application to implement a playback scheme that is independent of the main timeline.
- Parameters:
-
pState State of the Free running flag.
| bool GetFreeRunning | ( | ) | const |
| void SetLoop | ( | bool | pLoop | ) |
Set the Loop state of the video clip.
The Loop flag can be used by a client application to implement the loop playback of the video clip.
- Parameters:
-
pLoop State of the loop flag.
| bool GetLoop | ( | ) | const |
| void SetInterlaceMode | ( | EInterlaceMode | pInterlaceMode | ) |
Set the Interlace mode.
- Parameters:
-
pInterlaceMode Interlace mode identifier.
| EInterlaceMode GetInterlaceMode | ( | ) | const |
| void SetAccessMode | ( | EAccessMode | pAccessMode | ) |
Set the clip Access Mode.
- Parameters:
-
pAccessMode Clip access mode identifier.
| EAccessMode GetAccessMode | ( | ) | const |
| FbxError& GetError | ( | ) |
| EErrorCode GetLastErrorID | ( | ) | const |
| const char* GetLastErrorString | ( | ) | const |
| virtual void Construct | ( | const FbxVideo * | pFrom | ) | [protected, virtual] |
| virtual bool ConstructProperties | ( | bool | pForceSet | ) | [protected, virtual] |
Reimplemented from FbxObject.
| virtual bool ConnecNotify | ( | FbxConnectEvent const & | pEvent | ) | [protected, virtual] |
Reimplemented from FbxObject.
Copy an object content into this object.
- Parameters:
-
pObject The source object to copy data from.
- Returns:
- Returns the destination object being modified by the source.
- Remarks:
- This function replace the assignment operator (operator=). It will copy all property values and the name. Connections are NOT copied.
Reimplemented from FbxObject.
| virtual FbxStringList GetTypeFlags | ( | ) | const [virtual] |
Reimplemented from FbxObject.
| void SetOriginalFormat | ( | bool | pState | ) |
| bool GetOriginalFormat | ( | ) | const |
| void SetOriginalFilename | ( | const char * | pOriginalFilename | ) |
| const char* GetOriginalFilename | ( | ) | const |
| void Init | ( | ) | [protected] |
Member Data Documentation
Definition at line 296 of file fbxvideo.h.
Definition at line 297 of file fbxvideo.h.
Definition at line 298 of file fbxvideo.h.
Definition at line 299 of file fbxvideo.h.
Definition at line 300 of file fbxvideo.h.
Definition at line 301 of file fbxvideo.h.
Definition at line 302 of file fbxvideo.h.
Definition at line 303 of file fbxvideo.h.
Definition at line 304 of file fbxvideo.h.
Definition at line 305 of file fbxvideo.h.
Definition at line 306 of file fbxvideo.h.
Definition at line 307 of file fbxvideo.h.
Definition at line 308 of file fbxvideo.h.
Definition at line 309 of file fbxvideo.h.
Definition at line 310 of file fbxvideo.h.
Definition at line 315 of file fbxvideo.h.
bool mUseMipMap
[protected] |
Definition at line 317 of file fbxvideo.h.
bool mOriginalFormat
[protected] |
Definition at line 318 of file fbxvideo.h.
FbxString mOriginalFilename
[protected] |
Definition at line 319 of file fbxvideo.h.
FbxString mRelativeFilename
[protected] |
Definition at line 322 of file fbxvideo.h.
The documentation for this class was generated from the following file:
- fbxsdk/scene/fbxvideo.h
