fboptical.h

Go to the documentation of this file.

#ifndef __FBOPTICAL_H__
#define __FBOPTICAL_H__
/**************************************************************************
 Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.
 
 The coded instructions, statements, computer programs, and/or related 
 material (collectively the "Data") in these files contain unpublished 
 information proprietary to Autodesk, Inc. and/or its licensors, which is 
 protected by Canada and United States of America federal copyright law 
 and by international treaties.
 
 The Data may not be disclosed or distributed to third parties, in whole 
 or in part, without the prior written consent of Autodesk, Inc. 
 ("Autodesk").
 
 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
 ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
 OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
 PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
 WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
 FREE.
 
 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
 EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
 DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
 OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
 DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
 LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
 LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
 DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
 BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
 
**************************************************************************/

#include <kaydaradef.h>
#ifndef FBSDK_DLL 

    #define FBSDK_DLL K_DLLIMPORT
#endif

#ifndef FB_KERNEL

#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbmodel.h>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

__FB_FORWARD( FBModelOptical );

FB_DEFINE_COMPONENT( FBSDK_DLL, ModelOptical            );
FB_DEFINE_COMPONENT( FBSDK_DLL, ModelMarkerOptical  );
FB_DEFINE_COMPONENT( FBSDK_DLL, RigidBody           );
FB_DEFINE_COMPONENT( FBSDK_DLL, Take );

// FBOpticalSegement
__FB_FORWARD( FBOpticalSegment );
class FBSDK_DLL FBOpticalSegment : public FBComponent
{
    __FBClassDeclare( FBOpticalSegment, FBComponent );
  public:
    FBOpticalSegment(HFBModelOptical pOptical=NULL);

    FBOpticalSegment( const FBOpticalSegment &pSegment );

    bool operator==(const FBOpticalSegment &pValue) const;

    FBOpticalSegment& operator=(const FBOpticalSegment& pValue);

    virtual void Reset();

    virtual void Cut( FBTime& pTime );

    virtual bool IsValid();

    // original
    FBPropertyTimeSpan              OriginalTimeSpan;   
    FBPropertyTimeSpan              TimeSpan;           
    FBPropertyAnimationNode         Data;               
    FBPropertyBool                  Used;               

    // from marker
    FBPropertyModelMarkerOptical    Marker;             
    FBPropertyTimeSpan              MarkerTimeSpan;     

    friend class FBPropertyListOpticalSegment;
    friend class FBPropertyListMarkerSegment;

private:
    void FBOpticalSegmentInitProperties();
};
FB_DEFINE_COMPONENT ( FBSDK_DLL, OpticalSegment );
FB_DEFINE_ARRAY     ( FBSDK_DLL, OpticalSegment );
FB_DEFINE_LIST      ( FBSDK_DLL, OpticalSegment );

// FBPropertyListMarkerSegment
FB_FORWARD( FBPropertyListMarkerSegment );

class FBSDK_DLL FBPropertyListMarkerSegment : public FBPropertyBaseList< FBOpticalSegment >
{
  private:
    FBArrayTemplate< HFBOpticalSegment > mItems;
    virtual int Add( FBOpticalSegment pItem );
    virtual void Refresh();
  public:
    FBPropertyListMarkerSegment();
    virtual ~FBPropertyListMarkerSegment();
    virtual void RemoveAt ( int pIndex );

    virtual FBOpticalSegment operator[]( int pIndex );

    virtual int GetCount();

    virtual int GetIndexAt( FBTime& pTime );
};

// FBPropertyListOpticalSegment
FB_FORWARD( FBPropertyListOpticalSegment );
FB_DEFINE_LIST( FBSDK_DLL, OpticalSegment );

class FBSDK_DLL FBPropertyListOpticalSegment : public FBPropertyBaseList< FBOpticalSegment >
{
  private:
    FBArrayTemplate< HFBOpticalSegment > mItems;
    virtual int Add( FBOpticalSegment pItem );
    virtual void Refresh();
  public:
    FBPropertyListOpticalSegment();
    virtual ~FBPropertyListOpticalSegment();
    virtual void RemoveAt( int pIndex );

    virtual FBOpticalSegment operator[]( int pIndex );

    virtual int GetCount();

    virtual int Add( HFBAnimationNode pData );
};

// Gap mode
enum FBGapMode  {
    kFBGapRigidBody,    
    kFBGapConstant,     
    kFBGapLinear,       
    kFBGapBezier,       
    kFBGapCurve,        
    kFBGapSample        
};
FB_DEFINE_ENUM( FBSDK_DLL, GapMode );

// FBOpticalGap
__FB_FORWARD( FBOpticalGap );
class FBSDK_DLL FBOpticalGap : public FBComponent
{
    __FBClassDeclare( FBOpticalGap, FBComponent );
  public:
    FBOpticalGap(HFBModelMarkerOptical pMarker=NULL);

    FBOpticalGap(const FBOpticalGap& pGap);

    bool operator==(const FBOpticalGap &pValue) const;

    FBOpticalGap& operator=(const FBOpticalGap& pValue);

    virtual void InsertControlKey( FBTime& pTime );

    virtual bool IsValid();

    FBPropertyTimeSpan          TimeSpan;           
    FBPropertyGapMode           Interpolation;      
    FBPropertyAnimationNode     Data;               

    friend class FBPropertyListOpticalGap;

private:
    void FBOpticalGapInitProperties();
};
FB_DEFINE_COMPONENT ( FBSDK_DLL, OpticalGap );
FB_DEFINE_ARRAY     ( FBSDK_DLL, OpticalGap );
FB_DEFINE_LIST      ( FBSDK_DLL, OpticalGap );

// FBPropertyListOpticalGap
FB_FORWARD( FBPropertyListOpticalGap );

class FBSDK_DLL FBPropertyListOpticalGap : public FBPropertyBaseList< FBOpticalGap >
{
  private:
    FBArrayTemplate< HFBOpticalGap > mItems;
    virtual int     Add( FBOpticalGap pItem );
    virtual void    RemoveAt( int pIndex );
    virtual void    Refresh();
  public:
    FBPropertyListOpticalGap();
    virtual ~FBPropertyListOpticalGap();
    virtual FBOpticalGap operator[]( int pIndex );

    virtual int GetCount();
};

// FBModelMarkerOptical
__FB_FORWARD( FBModelMarkerOptical);
class FBSDK_DLL FBModelMarkerOptical : public FBModelMarker 
{
    __FBClassDeclare( FBModelMarkerOptical,FBModelMarker );
  public:
    FBModelMarkerOptical(char *pName = NULL, HFBModelOptical pOptical=NULL, HIObject pObject=NULL );

    virtual int ImportBegin();

    virtual bool ImportKey( double pX, double pY, double pZ=0.0, double pOcclusion=0.0 );

    virtual bool ImportEnd();

    virtual int  ExportBegin();

    virtual bool ExportKey( double *pX, double *pY, double *pZ=NULL, double *pOcclusion=NULL );

    virtual bool ExportEnd();

    virtual void SetModelOptical( HFBModelOptical pOptical );

    virtual void InsertSegmentedData( HFBAnimationNode pTData, HFBAnimationNode pOData );

    virtual FBRigidBody GetRigidBody();

    FBPropertyModelOptical          Optical;        
    FBPropertyListMarkerSegment     Segments;       
    FBPropertyListOpticalGap        Gaps;           
    FBPropertyColor                 Color;          
    FBPropertyBool                  Done;           
    FBPropertyAnimationNode         Data;           
private:
    void FBModelMarkerOpticalInitProperties();
};
FB_DEFINE_ARRAY ( FBSDK_DLL, ModelMarkerOptical );
FB_DEFINE_LIST  ( FBSDK_DLL, ModelMarkerOptical );

// FBPropertyListModelMarkerOptical
FB_FORWARD( FBPropertyListModelMarkerOptical );

class FBSDK_DLL FBPropertyListModelMarkerOptical : public FBPropertyBaseList< HFBModelMarkerOptical >
{
  private:
    FBArrayTemplate< HFBModelMarkerOptical > mItems;
  public:
    FBPropertyListModelMarkerOptical();
    virtual ~FBPropertyListModelMarkerOptical();
    virtual void Refresh ();

    virtual void RemoveAt( int pIndex );

    virtual HFBModelMarkerOptical operator[]( int pIndex );

    virtual int GetCount ();

    virtual int Add( char* pName = NULL );

    virtual int Add( HFBModelMarkerOptical pItem );
};

// FBPropertyListRigidBodyMarkers
FB_FORWARD( FBPropertyListRigidBodyMarkers );
FB_DEFINE_LIST( FBSDK_DLL, ModelMarkerOptical );

class FBSDK_DLL FBPropertyListRigidBodyMarkers : public FBPropertyBaseList< HFBModelMarkerOptical >
{
  private:
    FBArrayTemplate< HFBModelMarkerOptical > mItems;
  public:
    FBPropertyListRigidBodyMarkers();
    virtual ~FBPropertyListRigidBodyMarkers();
    virtual void Refresh();

    virtual void RemoveAt( int pIndex );

    virtual HFBModelMarkerOptical operator[]( int pIndex );

    virtual int GetCount ();

  public:
    virtual int Add( char* pName = NULL );
    virtual int Add( HFBModelMarkerOptical pItem );
};

// Rigid body mode
enum FBRigidBodyMode {
    kFBRigidBodyFast,   
    kFBRigidBodyBest    
};
FB_DEFINE_ENUM( FBSDK_DLL, RigidBodyMode );

// FBRigidBody
__FB_FORWARD( FBRigidBody );
class FBSDK_DLL FBRigidBody : public FBComponent
{
    __FBClassDeclare( FBRigidBody, FBComponent );
  public:
    FBRigidBody(HFBModelOptical pOptical=NULL);

    FBRigidBody( const FBRigidBody &pRigidBody );

    bool operator==(const FBRigidBody &pValue) const;

    FBRigidBody& operator=(const FBRigidBody& pValue);

    virtual void Snap();

    virtual void ComputeAnimation();

    virtual bool IsValid();

    FBPropertyListRigidBodyMarkers      Markers;        
    FBPropertyModel                     Model;          
    FBPropertyAnimationNode             QualityData;    
    FBPropertyBool                      Done;           
    FBPropertyRigidBodyMode             Mode;           
    FBPropertyInt                       SmoothWidth;    

    friend class FBPropertyListRigidBody;
private:
    void FBRigidBodyInitProperties();

};
FB_DEFINE_ARRAY ( FBSDK_DLL, RigidBody  );
FB_DEFINE_LIST  ( FBSDK_DLL, RigidBody );

// FBPropertyListRigidBody
FB_FORWARD( FBPropertyListRigidBody );

class FBSDK_DLL FBPropertyListRigidBody : public FBPropertyBaseList< FBRigidBody >
{
  private:
    FBArrayTemplate< HFBRigidBody > mItems;
    virtual int     Add     ( FBRigidBody pItem );
    virtual void    Refresh ();
  public:
    FBPropertyListRigidBody();
    virtual ~FBPropertyListRigidBody();
    virtual void RemoveAt( int pIndex );

    virtual FBRigidBody operator[]( int pIndex );

    virtual int GetCount();

    virtual int Add( FBModelList& pList, char* pName=NULL);
};

// FBModelOptical
__FB_FORWARD( FBModelOptical );
class FBSDK_DLL FBModelOptical : public FBModel 
{
    __FBClassDeclare( FBModelOptical,FBModel );
  public:
    FBModelOptical(char * pName, HIObject pObject=NULL);

    virtual bool ImportSetup();

    virtual bool ExportSetup();

    virtual void ClearSegments( bool pUnUsedOnly = true );

    FBPropertyDouble                    MarkerSize;         
    FBPropertyTime                      SamplingStart;      
    FBPropertyTime                      SamplingStop;       
    FBPropertyTime                      SamplingPeriod;     

    FBPropertyListModelMarkerOptical    Markers;            
    FBPropertyListOpticalSegment        Segments;           
    FBPropertyListRigidBody             RigidBodies;        
};

// FBGenerationMode
enum FBGenerationMode   {
    kFBGenerationNone,  
    kFBGenerationFast   
};
FB_DEFINE_ENUM( FBSDK_DLL, GenerationMode );

// FBControllerMode
enum FBControllerMode   {
    kFBControllerNone,          
    kFBControllerLabelling,     
    kFBControllerSegment,       
    kFBControllerRigidBody      
};
FB_DEFINE_ENUM( FBSDK_DLL, ControllerMode );

// FBSegmentMode
enum FBSegmentMode  {
    kFBSegmentMarker,           
    kFBSegmentRigidBody,        
    kFBSegmentAll               
};
FB_DEFINE_ENUM( FBSDK_DLL, SegmentMode );

// FBInsertSegmentMode
enum FBInsertSegmentMode    {
    kFBInsertSegmentWhole,      
    kFBInsertSegmentToEnd,      
    kFBInsertSegmentFromStart   
};
FB_DEFINE_ENUM( FBSDK_DLL, InsertSegmentMode );

// FBModelOpticalAdvanced
__FB_FORWARD( FBModelOpticalAdvanced );
class FBSDK_DLL FBModelOpticalAdvanced : public FBComponent
{
    __FBClassDeclare( FBModelOpticalAdvanced,FBComponent );
  public:
    FBModelOpticalAdvanced( HFBModelOptical pOptical );

    virtual void AcceptAllSegments();

    virtual void AcceptSegment();

    virtual void SkipSegment();

    virtual void AutomaticBuild();

    virtual void CropSegmentsAnimation();

    FBPropertyAnimationNode         Quality;                
    FBPropertyBool                  ShowRigidQuality;       
    FBPropertyGenerationMode        GenerationMode;         
    FBPropertyControllerMode        ControllerMode;         
    FBPropertySegmentMode           SegmentMode;            
    FBPropertyInsertSegmentMode     InsertSegmentMode;      
    FBPropertyBool                  PlayToNextSegment;      
    FBPropertyBool                  AutoPlayToNextSegment;  
    FBPropertyDouble                MaxMatchDistance;       
    FBPropertyBool                  Active;                 
    FBPropertyTake                  UsedTake;               
};

// FBDeviceOpticalMarker
__FB_FORWARD( FBDeviceOpticalMarker );
class FBSDK_DLL FBDeviceOpticalMarker : public FBComponent {
    __FBClassDeclare( FBDeviceOpticalMarker,FBComponent );
  public:
    FBDeviceOpticalMarker(char *pName);

    void SetData(double pX, double pY, double pZ=0.0, double pOcclusion=0.0);

    FBPropertyBool          IsUsed;         
    FBPropertyVector3d      Position;       
    FBPropertyDouble        Occlusion;      
    FBPropertyModel         Model;          
};
FB_DEFINE_ARRAY ( FBSDK_DLL, DeviceOpticalMarker );
FB_DEFINE_LIST  ( FBSDK_DLL, DeviceOpticalMarker );

// FBPropertyListDeviceOpticalMarker
FB_FORWARD( FBPropertyListDeviceOpticalMarker );

class FBSDK_DLL FBPropertyListDeviceOpticalMarker : public FBPropertyBaseList< HFBDeviceOpticalMarker >
{
    FBArrayTemplate<HFBDeviceOpticalMarker> mItems;         
    virtual int  Add    ( HFBDeviceOpticalMarker pItem );   
  public:
    FBPropertyListDeviceOpticalMarker();
    virtual ~FBPropertyListDeviceOpticalMarker();
    virtual void RemoveAt( int pIndex );
    virtual HFBDeviceOpticalMarker operator[](int pIndex);
    virtual int GetCount();

    virtual int Add( char *pName=NULL );
};

// FBDeviceOptical
__FB_FORWARD( FBDeviceOptical );
class FBSDK_DLL FBDeviceOptical : public FBDevice 
{
    __FBClassDeclare( FBDeviceOptical,FBDevice );
  public:
    friend class FBDeviceOpticalLayout;
    //IObject_Declare                       ( Implementation );
    FBDeviceOptical(char *pName, HIObject pObject=NULL);

    FBPropertyListDeviceOpticalMarker   Markers;                    
    FBPropertyBool                      SupportOcclusion;           
    FBPropertyBool                      AutoAntialiasing;           
    FBPropertyDouble                    DampingTime;                
    FBPropertyModel                     ModelOptical;               

    FBPropertyBool                      ForceOpticalSamplingRate;   
    FBPropertyDouble                    OpticalSamplingRate;        
    FBPropertyBool                      UseMarkerTimeStamp;         

    FBPropertyBool                      SkipFrame;                  
    FBPropertyTime                      MarkerTimeStamp;            

    //----Does marker management----
    void DeviceOpticalBeginSetup();     
    void DeviceOpticalEndSetup();       

    virtual void DeviceOpticalEvalAllMarkers(FBDeviceNotifyInfo &pDeviceNotifyInfo);
 
    virtual void DeviceOpticalRecordFrame(FBTime &pTime,FBDeviceNotifyInfo &pDeviceNotifyInfo);
    
    //--- See base class ---

    // Standard FBX interface functions
    virtual bool FbxStore(HFBFbxObject pFbxObject,kFbxObjectStore pStoreWhat);
    virtual bool FbxRetrieve(HFBFbxObject pFbxObject,kFbxObjectStore pStoreWhat);

    // Standard device virtual functions creation/destruction
    virtual bool FBCreate();
    virtual void FBDestroy();

    // Standard device virtual function device operation notify
    virtual bool DeviceOperation( kDeviceOperations pOperation );
    
    // Standard device virtual functions evaluation
    virtual bool AnimationNodeNotify(HFBAnimationNode pAnimationNode,HFBEvaluateInfo pEvaluateInfo);
    virtual void DeviceIONotify(kDeviceIOs pAction,FBDeviceNotifyInfo &pDeviceNotifyInfo);

    // Standard device virtual functions recording for animation.
    virtual void RecordingInitAnimation(HFBAnimationNode pAnimationNode);
    virtual void RecordingDoneAnimation(HFBAnimationNode pAnimationNode);
};

#ifdef FBSDKUseNamespace
}
#endif

#endif
#endif