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

Search for all occurrences

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbobjectpose.h.

---

Enumeration Type Documentation

enum FBPoseTransformType

Search for all occurrences

Transform mode of pose.

Enumerator:

kFBPoseTransformInvalid	Search for all occurrences
kFBPoseTransformLocal	Search for all occurrences
kFBPoseTransformGlobal	Search for all occurrences
kFBPoseTransformLocalRef	Search for all occurrences
kFBPoseTransformTypeCount	Search for all occurrences

Definition at line 60 of file fbobjectpose.h.

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

enum FBObjectPoseOptionsFlag

Search for all occurrences

ObjectPoseOptions flags.

Enumerator:

kFBObjectPoseOptionsNoFlag	Search for all occurrences
kFBObjectPoseOptionsTranslationX	Search for all occurrences
kFBObjectPoseOptionsTranslationY	Search for all occurrences
kFBObjectPoseOptionsTranslationZ	Search for all occurrences
kFBObjectPoseOptionsRotation	Search for all occurrences
kFBObjectPoseOptionsScaling	Search for all occurrences

Definition at line 70 of file fbobjectpose.h.

{
    kFBObjectPoseOptionsNoFlag      = 0,
    kFBObjectPoseOptionsTranslationX= 1,
    kFBObjectPoseOptionsTranslationY= 1<<1,
    kFBObjectPoseOptionsTranslationZ= 1<<2,
    kFBObjectPoseOptionsRotation    = 1<<3,
    kFBObjectPoseOptionsScaling     = 1<<4,
};

enum FBObjectPoseMirrorOptionsFlag

Search for all occurrences

ObjectPoseMirrorOptions flags.

Enumerator:

kFBObjectPoseMirrorOptionsNoFlag	Search for all occurrences
kFBObjectPoseMirrorOptionsUpdateLocal	Search for all occurrences
kFBObjectPoseMirrorOptionsUpdateLocalMirrorParent	Search for all occurrences
kFBObjectPoseMirrorOptionsUpdateLocalRef	Search for all occurrences
kFBObjectPoseMirrorOptionsUpdateLocalRefMirrorRef	Search for all occurrences

Definition at line 81 of file fbobjectpose.h.

{
    kFBObjectPoseMirrorOptionsNoFlag                    = 0,
    kFBObjectPoseMirrorOptionsUpdateLocal               = 1,
    kFBObjectPoseMirrorOptionsUpdateLocalMirrorParent   = 1<<1,
    kFBObjectPoseMirrorOptionsUpdateLocalRef            = 1<<2,
    kFBObjectPoseMirrorOptionsUpdateLocalRefMirrorRef   = 1<<3,
};

---

Function Documentation

FB_FORWARD

(

FBObjectPoseOptions

)

Search for all occurrences

FB_FORWARD

(

FBObjectPoseMirrorOptions

)

Search for all occurrences

__FB_FORWARD

(

FBObjectPose

)

Search for all occurrences

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

Search for all occurrences

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

Parameters:

pPlaneEquation	Out: The plane equation computed.
pPlaneNormalVector	Normal vector to the plane.
pPointOnPlane	A point on the plane.

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

Search for all occurrences

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

Parameters:

pPlaneEquation	Out: The plane equation computed.
pPointOnPlane	A point on the plane.
pPlaneRM	Rotation matrix of the plane, identity being the plane XZ.

FBSDK_DLL void GetPlaneRotation	(	FBMatrix &	pPlaneRM,
		const FBVector4< double > &	pPlaneEquation
	)

Search for all occurrences

Get the plane rotation matrix from a plane equation.

Parameters:

pPlaneRM	Out: Rotation matrix of the plane, identity being the plane XZ.
pPlaneEquation	The equation of the plane.

FBSDK_DLL void NormalizePlaneEquation	(	FBVector4< double > &	pNormalizedPlaneEquation,
		FBVector4< double > &	pPlaneEquation
	)

Search for all occurrences

Normalize a plane equation.

Parameters:

pNormalizedPlaneEquation	Out: Plane equation normalized.
pPlaneEquation	Plane 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
	)

Search for all occurrences

Mirror a transformation using the specified mirror plane.

Parameters:

pMirrorT	Out: Mirrored translation.
pMirrorRM	Out: Mirrored rotation.
pMirrorSM	Out: Mirrored scaling.
pT	Translation to mirror.
pRM	Rotation to mirror.
pSM	Scaling to mirror.
pPlaneEquation	The equation of the mirror plane.

FBSDK_DLL void MirrorTransformT	(	FBTVector &	pMirrorT,
		const FBTVector &	pT,
		const FBVector4< double > &	pPlaneEquation
	)

Search for all occurrences

Mirror a translation using the specified mirror plane.

Parameters:

pMirrorT	Out: Mirrored translation.
pT	Translation to mirror.
pPlaneEquation	The equation of the mirror plane.

FBSDK_DLL void MirrorTransformR	(	FBMatrix &	pMirrorRM,
		const FBMatrix &	pRM,
		const FBVector4< double > &	pPlaneEquation
	)

Search for all occurrences

Mirror a rotation using the specified mirror plane.

Parameters:

pMirrorRM	Out: Mirrored rotation.
pRM	Rotation to mirror.
pPlaneEquation	The equation of the mirror plane.