FBX C++ API Reference
fbxvideo.h
Go to the documentation of this file.
1 /****************************************************************************************
2 
3  Copyright (C) 2016 Autodesk, Inc.
4  All rights reserved.
5 
6  Use of this software is subject to the terms of the Autodesk license agreement
7  provided at the time of installation or download, or which otherwise accompanies
8  this software in either electronic or hard copy form.
9 
10 ****************************************************************************************/
11 
13 #ifndef _FBXSDK_SCENE_VIDEO_H_
14 #define _FBXSDK_SCENE_VIDEO_H_
15 
16 #include <fbxsdk/fbxsdk_def.h>
17 
19 
20 #include <fbxsdk/fbxsdk_nsbegin.h>
21 
26 {
28 
29 public:
34  virtual void Reset();
37 
45  void ImageTextureSetMipMap(bool pUseMipMap);
46 
50  bool ImageTextureGetMipMap() const;
51 
57  virtual bool SetFileName(const char* pName);
58 
64  virtual bool SetRelativeFileName(const char* pName);
65 
80  void SetImageSequence(bool pImageSequence);
81 
85  bool GetImageSequence() const;
86 
90  void SetImageSequenceOffset(int pOffset);
91 
95  int GetImageSequenceOffset() const;
97 
101  double GetFrameRate() const;
102 
106  int GetLastFrame() const;
107 
111  int GetWidth() const;
112 
116  int GetHeight() const;
117 
123  void SetStartFrame(int pStartFrame);
124 
128  int GetStartFrame() const;
129 
135  void SetStopFrame(int pStopFrame);
136 
140  int GetStopFrame() const;
141 
145  {
153  eFullOddEven
154  };
155 
159  void SetInterlaceMode(EInterlaceMode pInterlaceMode);
160 
164  EInterlaceMode GetInterlaceMode() const;
165 
167 
168 /*****************************************************************************************************************************
169 ** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
170 *****************************************************************************************************************************/
171 #ifndef DOXYGEN_SHOULD_SKIP_THIS
172 protected:
173  virtual void Construct(const FbxObject* pFrom);
174  virtual void ConstructProperties(bool pForceSet);
175  virtual bool ConnectNotify(FbxConnectEvent const &pEvent);
176 
177 public:
178  virtual FbxObject& Copy(const FbxObject& pObject);
179 
180  FbxPropertyT<FbxBool> ImageSequence;
181  FbxPropertyT<FbxInt> ImageSequenceOffset;
182  FbxPropertyT<FbxDouble> FrameRate;
183  FbxPropertyT<FbxInt> LastFrame;
184  FbxPropertyT<FbxInt> Width;
185  FbxPropertyT<FbxInt> Height;
186  FbxPropertyT<FbxInt> StartFrame;
187  FbxPropertyT<FbxInt> StopFrame;
188  FbxPropertyT<EInterlaceMode> InterlaceMode;
189 
190 protected:
191  void Init();
192 
193  bool mUseMipMap;
194 
195 #endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
196 };
197 
199 
200 #include <fbxsdk/fbxsdk_nsend.h>
201 
202 #endif /* _FBXSDK_SCENE_VIDEO_H_ */
#define FBXSDK_OBJECT_DECLARE(Class, Parent)
Macro used to declare a new class derived from FbxObject.
Definition: fbxobject.h:61
FBX SDK environment definition.
EInterlaceMode
Video interlace modes.
Definition: fbxvideo.h:144
Half of a frame, odd fields only.
Definition: fbxvideo.h:149
virtual void Reset()
Reset the clip to default values.
FBX SDK video class.
Definition: fbxvideo.h:25
Extract and use the odd field of a full frame.
Definition: fbxvideo.h:151
virtual FbxObject & Copy(const FbxObject &pObject)
Copy an object content into this object.
Half of a frame, even fields only.
Definition: fbxvideo.h:148
EFbxType
Type identifier constants.
Progressive frame (full frame).
Definition: fbxvideo.h:146
The base class of most FBX objects.
Definition: fbxobject.h:157
FBX SDK media clip class.
Definition: fbxmediaclip.h:25
virtual void Construct(const FbxObject *pFrom)
Optional constructor override, automatically called by default constructor.
Alternate even/odd fields.
Definition: fbxvideo.h:147
Enumeration.
EFbxType FbxTypeOf(const FbxVideo::EInterlaceMode &)
Definition: fbxvideo.h:198
#define FBXSDK_DLL
Definition: fbxarch.h:173
Extract and use the even field of a full frame.
Definition: fbxvideo.h:150
Extract eFields and make full frame with each one beginning with Odd (60fps).
Definition: fbxvideo.h:152
virtual void ConstructProperties(bool pForceSet)
Optional property constructor override, automatically called by default constructor.
virtual bool SetFileName(const char *pName)
Specify the media full filename.
virtual bool SetRelativeFileName(const char *pName)
Specify the media relative filename.