fbobjectpose.h File Reference

Contains definitions for object poses. More...

#include <kaydaradef.h>
#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbpose.h>

Go to the source code of this file.

Classes

class  FBObjectPoseOptions
 FBObjectPoseOptions class. More...
class  FBObjectPoseMirrorOptions
 FBObjectPoseMirrorOptions class. More...
class  FBObjectPose
 FBObjectPose class. More...
class  FBPropertyListObjectPose
 PropertyList: ObjectPose. More...

Defines

#define FBSDK_DLL   K_DLLIMPORT
 Be sure that FBSDK_DLL is defined only once...

Enumerations

enum  FBPoseTransformType {
  kFBPoseTransformInvalid = -1, kFBPoseTransformLocal = 0, kFBPoseTransformGlobal, kFBPoseTransformLocalRef,
  kFBPoseTransformTypeCount
}
 

Transform mode of pose.

More...
enum  FBObjectPoseOptionsFlag {
  kFBObjectPoseOptionsNoFlag = 0, kFBObjectPoseOptionsTranslationX = 1, kFBObjectPoseOptionsTranslationY = 1<<1, kFBObjectPoseOptionsTranslationZ = 1<<2,
  kFBObjectPoseOptionsRotation = 1<<3, kFBObjectPoseOptionsScaling = 1<<4
}
 

ObjectPoseOptions flags.

More...
enum  FBObjectPoseMirrorOptionsFlag {
  kFBObjectPoseMirrorOptionsNoFlag = 0, kFBObjectPoseMirrorOptionsUpdateLocal = 1, kFBObjectPoseMirrorOptionsUpdateLocalMirrorParent = 1<<1, kFBObjectPoseMirrorOptionsUpdateLocalRef = 1<<2,
  kFBObjectPoseMirrorOptionsUpdateLocalRefMirrorRef = 1<<3
}
 

ObjectPoseMirrorOptions flags.

More...

Functions

 FB_FORWARD (FBObjectPoseOptions)
 FB_FORWARD (FBObjectPoseMirrorOptions)
 __FB_FORWARD (FBObjectPose)
FBSDK_DLL void GetPlaneEquation (FBVector4< double > &pPlaneEquation, const FBTVector &pPlaneNormalVector, const FBTVector &pPointOnPlane)
 Get a plane equation from a normal vector and a point on the plane.
FBSDK_DLL void GetPlaneEquation (FBVector4< double > &pPlaneEquation, const FBTVector &pPointOnPlane, const FBMatrix &pPlaneRM)
 Get a plane equation from a point on the plane and a rotation matrix relative to the plane XZ.
FBSDK_DLL void GetPlaneRotation (FBMatrix &pPlaneRM, const FBVector4< double > &pPlaneEquation)
 Get the plane rotation matrix from a plane equation.
FBSDK_DLL void NormalizePlaneEquation (FBVector4< double > &pNormalizedPlaneEquation, FBVector4< double > &pPlaneEquation)
 Normalize a plane equation.
FBSDK_DLL void MirrorTransform (FBTVector &pMirrorT, FBMatrix &pMirrorRM, FBMatrix &pMirrorSM, const FBTVector &pT, const FBMatrix &pRM, const FBMatrix &pSM, const FBVector4< double > &pPlaneEquation)
 Mirror a transformation using the specified mirror plane.
FBSDK_DLL void MirrorTransformT (FBTVector &pMirrorT, const FBTVector &pT, const FBVector4< double > &pPlaneEquation)
 Mirror a translation using the specified mirror plane.
FBSDK_DLL void MirrorTransformR (FBMatrix &pMirrorRM, const FBMatrix &pRM, const FBVector4< double > &pPlaneEquation)
 Mirror a rotation using the specified mirror plane.

Detailed Description

Contains definitions for object poses.

Definition in file fbobjectpose.h.


Define Documentation

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbobjectpose.h.


Enumeration Type Documentation

Transform mode of pose.

Enumerator:
kFBPoseTransformInvalid 
kFBPoseTransformLocal 
kFBPoseTransformGlobal 
kFBPoseTransformLocalRef 
kFBPoseTransformTypeCount 

Definition at line 60 of file fbobjectpose.h.

ObjectPoseOptions flags.

Enumerator:
kFBObjectPoseOptionsNoFlag 
kFBObjectPoseOptionsTranslationX 
kFBObjectPoseOptionsTranslationY 
kFBObjectPoseOptionsTranslationZ 
kFBObjectPoseOptionsRotation 
kFBObjectPoseOptionsScaling 

Definition at line 70 of file fbobjectpose.h.

ObjectPoseMirrorOptions flags.

Enumerator:
kFBObjectPoseMirrorOptionsNoFlag 
kFBObjectPoseMirrorOptionsUpdateLocal 
kFBObjectPoseMirrorOptionsUpdateLocalMirrorParent 
kFBObjectPoseMirrorOptionsUpdateLocalRef 
kFBObjectPoseMirrorOptionsUpdateLocalRefMirrorRef 

Definition at line 81 of file fbobjectpose.h.


Function Documentation

FBSDK_DLL void GetPlaneEquation ( FBVector4< double > &  pPlaneEquation,
const FBTVector pPlaneNormalVector,
const FBTVector pPointOnPlane 
)

Get a plane equation from a normal vector and a point on the plane.

Parameters:
pPlaneEquationOut: The plane equation computed.
pPlaneNormalVectorNormal vector to the plane.
pPointOnPlaneA point on the plane.
FBSDK_DLL void GetPlaneEquation ( FBVector4< double > &  pPlaneEquation,
const FBTVector pPointOnPlane,
const FBMatrix pPlaneRM 
)

Get a plane equation from a point on the plane and a rotation matrix relative to the plane XZ.

Parameters:
pPlaneEquationOut: The plane equation computed.
pPointOnPlaneA point on the plane.
pPlaneRMRotation matrix of the plane, identity being the plane XZ.
FBSDK_DLL void GetPlaneRotation ( FBMatrix pPlaneRM,
const FBVector4< double > &  pPlaneEquation 
)

Get the plane rotation matrix from a plane equation.

Parameters:
pPlaneRMOut: Rotation matrix of the plane, identity being the plane XZ.
pPlaneEquationThe equation of the plane.
FBSDK_DLL void NormalizePlaneEquation ( FBVector4< double > &  pNormalizedPlaneEquation,
FBVector4< double > &  pPlaneEquation 
)

Normalize a plane equation.

Parameters:
pNormalizedPlaneEquationOut: Plane equation normalized.
pPlaneEquationPlane equation to normalized.
FBSDK_DLL void MirrorTransform ( FBTVector pMirrorT,
FBMatrix pMirrorRM,
FBMatrix pMirrorSM,
const FBTVector pT,
const FBMatrix pRM,
const FBMatrix pSM,
const FBVector4< double > &  pPlaneEquation 
)

Mirror a transformation using the specified mirror plane.

Parameters:
pMirrorTOut: Mirrored translation.
pMirrorRMOut: Mirrored rotation.
pMirrorSMOut: Mirrored scaling.
pTTranslation to mirror.
pRMRotation to mirror.
pSMScaling to mirror.
pPlaneEquationThe equation of the mirror plane.
FBSDK_DLL void MirrorTransformT ( FBTVector pMirrorT,
const FBTVector pT,
const FBVector4< double > &  pPlaneEquation 
)

Mirror a translation using the specified mirror plane.

Parameters:
pMirrorTOut: Mirrored translation.
pTTranslation to mirror.
pPlaneEquationThe equation of the mirror plane.
FBSDK_DLL void MirrorTransformR ( FBMatrix pMirrorRM,
const FBMatrix pRM,
const FBVector4< double > &  pPlaneEquation 
)

Mirror a rotation using the specified mirror plane.

Parameters:
pMirrorRMOut: Mirrored rotation.
pRMRotation to mirror.
pPlaneEquationThe equation of the mirror plane.