Creates custom cameras and manages system cameras. More...

#include <fbcamera.h>

Inheritance diagram for FBCamera:

[legend]

Public Member Functions
	FBCamera (const char *pName, HIObject pObject=NULL)
	Constructor. More...

void	GetCameraMatrix (FBMatrix &pMatrix, FBCameraMatrixType pType, FBEvaluateInfo *pEvalInfo=NULL)
	Obtains the camera's matrix. More...

FBVector4d	InverseProjection (int pX, int pY, double pDistanceFromCamera, bool pRelativeToViewport=false)
	Returns the world coordinates based on screen coordinates and input distance from the camera. More...

void	GetAnimatableFarPlane (FBPropertyAnimatableDouble *pProp)

void	GetAnimatableNearPlane (FBPropertyAnimatableDouble *pProp)

Public Member Functions inherited from FBModel
	FBModel (const char *pName, HIObject pObject=NULL)
	Constructor. More...

virtual void	FBDelete () override
	Open Reality deletion function. More...

	IQuery_Declare (override)
	Interface to IObject. More...

	ICallback_Declare (override)
	Interface to ICallback. More...

virtual FBModel *	Clone ()
	Clone the model. More...

void	SetMatrix (FBMatrix pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=true, bool pPushUndo=false, FBEvaluateInfo *pEvaluateInfo=NULL)
	Set a matrix for the model. More...

void	GetMatrix (FBMatrix &pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=true, FBEvaluateInfo *pEvaluateInfo=NULL)
	Get a matrix from the model. More...

void	GetLocalTransformationMatrixWithGlobalRotationDoF (FBMatrix &pMatrix, bool pInverse=false, FBEvaluateInfo *pEvaluateInfo=NULL)
	Get the local transformation (or local inverse transformation) matrix with the global Rotation DoF values from the model. More...

void	SetVector (FBVector3d pVector, FBModelTransformationType pWhat=kModelTranslation, bool pGlobalInfo=true, bool pPushUndo=false, FBEvaluateInfo *pEvaluateInfo=NULL)
	Set a vector for the model. More...

void	GetVector (FBVector3d &pVector, FBModelTransformationType pWhat=kModelTranslation, bool pGlobalInfo=true, FBEvaluateInfo *pEvaluateInfo=NULL)
	Get a vector from the model. More...

bool	IsEvaluationReady (FBModelEvaluationTaskType pWhat, FBEvaluateInfo *pEvaluateInfo=NULL) const
	Is the model's evaluation task result ready. More...

void	MatrixToRotation (FBRVector &pRotation, const FBMatrix &pMatrix)
	Convert Rotation Matrix to Euler Vector based on model's rotation order. More...

void	RotationToMatrix (FBMatrix &pMatrix, const FBRVector &pRotation)
	Convert Euler Vector to Rotation Matrix based on model's rotation order. More...

void	LRMToDof (FBRVector &pDof, const FBMatrix &pLM)
	Convert local matrix to object space vector. More...

void	DofToLRM (FBMatrix &pLM, const FBRVector &pDof)
	Convert object space vector to local matrix. More...

void	SetSchematicPosition (int pX, int pY)
	Set the position in the schematic view for the model. More...

void	SetSchematicPosition (FBVector2d pVector2d)
	Set the position in the schematic view for the model. More...

FBVector2d	GetSchematicPosition ()
	Get the position in the schematic view for the model. More...

void	GetBoundingBox (FBVector3d &pMin, FBVector3d &pMax)
	Get the bounding box of the model. More...

bool	IsVisible (FBEvaluateInfo *pEvaluateInfo=NULL)
	If the model is visible. More...

FBModelCullingMode	GetCullingMode () const
	Get Model Culling Mode. More...

void	SetCullingMode (FBModelCullingMode pCullingMode)
	Set Model Cullin Mode. More...

void	ForceAlwaysEvaluate ()
	Force Always Evaluate. More...

bool	IsForceAlwaysEvaluate ()
	Return Force Always Evaluate status. More...

int	NoFrustumCullingRequire ()
	Acquire no frustum culling request. More...

int	NoFrustumCullingRelease ()
	Release no frustum culling request. More...

bool	UseFrustumCulling ()
	Get the current Frustum Culling Status. More...

virtual bool	HasCustomDisplay ()
	Function to overload to handle custom display. More...

virtual void	CustomModelDisplay (FBCamera *pCamera, FBModelShadingMode pShadingMode, FBModelRenderPass pRenderPass, float pPickingAreaWidth, float pPickingAreaHeight)
	Custom display function, called when HasCustomDisplay returns true;. More...

virtual bool	CustomModelPicking (int pNbHits, unsigned int pSelectBuffer, FBCamera pCamera, int pMouseX, int pMouseY, FBTVector pLocalRaySrc, FBTVector pLocalRayDir, FBTVector pWorldRaySrc, FBTVector pWorldRayDir, FBMatrix pGlobalInverseMatrix, FBTVector pOutPickedPoint)
	Custom picking for selection, called when HasCustomDisplay returns true;. More...

virtual bool	ClosestRayIntersection (const FBTVector &pRayOrigin, const FBTVector &pRayEnd, FBTVector &pIntersectPos, FBNormal &pIntersectNormal)
	Determines the first intersection point's position and normal between ray and model surface More...

unsigned char *	GetSelectedPoints ()
	Get the list of the points selection state. More...

int	GetSelectedPointsCount ()
	Get the number of selected points in the model. More...

bool	SetAdditionalUniqueColorIDCount (unsigned int pCount)
	Request additional Unique color IDs. More...

unsigned int	GetAdditionalUniqueColorIDCount () const
	Get additional unique color count. More...

FBColor	GetAdditionalUniqueColorID (unsigned int pIndex) const
	Get Additional Unique Color Id. More...

virtual bool	FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override
	Store and Retrieve function that can be overloaded. More...

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override
	Request additional Unique color IDs. More...

void	SetupPropertiesForShapes ()
	Setup Shape Properties. More...

bool	RayCast (FBCamera *pCamera, int pMouseX, int pMouseY, FBVector3d &pHitPosition, FBVector3d &pHitNormal)
	Ray cast test. More...

virtual const char *	FbxGetObjectType () override
	Returns the class type inherited by the class of an object, for example: 'Model'. More...

virtual const char *	FbxGetObjectSubType () override
	Returns the class sub type inherited by the class of an object, for example: 'Default', 'Mesh'. More...

void	SetMatrixWithPrecision (FBMatrix pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=true, bool pPushUndo=false, FBEvaluateInfo *pEvaluateInfo=NULL, double pPrecision=FBMat2EulerDegenerateForPrecision10)
	Set a matrix for the model. More...

unsigned int	GetHierarchyWorldMatrices (FBMatrix pMatricesArray, unsigned int pMatricesArrayCount, FBModelHiercharyTraverserType pHiercharyTraverserType, FBEvaluateInfo pEvaluateInfo=NULL)
	Computes the global transform matrices between this model and all its children (all levels). More...

void	CollapseInSchematic ()
	Collapse the model in the schematic view. More...

void	ExpandInSchematic ()
	Expand the model in the schematic view. More...

bool	IsCollapsedInSchematic () const
	Returns if the model is collapsed or not (expanded) in the schematic view. More...

virtual bool	ManipulatorNotify (FBSelectionAction pAction)
	Callback for component selection in custom FBModel. More...

Public Member Functions inherited from FBBox
	FBBox (const char *pName, HIObject pObject=NULL)
	Constructor. More...

virtual FBAnimationNode *	AnimationNodeInCreate (kReference pUserId, const char pName, const char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)
	Creation of IN/OUT Animation Nodes. More...

virtual FBAnimationNode *	AnimationNodeOutCreate (kReference pUserId, const char pName, const char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)

virtual bool	EvaluateAnimationNodes (FBEvaluateInfo *pEvaluateInfo)
	Evaluation of non TRS nodes that needs to be evaluated. More...

virtual bool	AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Notification function for animation thread. More...

virtual bool	ResolveCandidate (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Function is call when candidate needs to be resolved (like global to local). More...

virtual ECandidateAction	SetGlobalCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a global candidate is set on an animation node. More...

virtual ECandidateAction	SetStdCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a non-global candidate is set on an animation node. More...

virtual bool	AnimationNodeDestroy (FBAnimationNode *pAnimationNode)
	Destroy an animation node. More...

virtual bool	AnimationNodeIsUserData (FBAnimationNode *pAnimationNode)
	Is the animation node user data? More...

virtual void	AnimationNodesOutDisableIfNotWritten (FBEvaluateInfo *pEvaluateInfo)
	This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo. More...

virtual FBAnimationNode *	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box. More...

virtual FBAnimationNode *	AnimationNodeOutGet ()

	IObject_Declare (override)

virtual int	GetOutConnectorCount () const
	Get the number of animation node outputs for this box. More...

virtual int	GetInConnectorCount () const
	Get the number of animation node inputs for this box. More...

virtual FBAnimationNode *	GetOutConnector (int pIndex) const
	Get the animation node output associated with the given index. More...

virtual FBAnimationNode *	GetInConnector (int pIndex) const
	Get the animation node input associated with the given index. More...

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor. More...

virtual	~FBComponent ()
	Destructor. More...

virtual bool	FBCreate ()
	Open Reality Creation function. More...

virtual void	FBDestroy ()
	Open Reality destruction function. More...

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer. More...

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager. More...

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager. More...

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading. More...

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property. More...

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated). More...

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags. More...

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled. More...

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags. More...

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags. More...

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status. More...

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled. More...

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace. More...

virtual const char *	ClassName () override
	Get the class name. More...

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not. More...

const char *	GetFullName (void)
	Get the full name. More...

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object. More...

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object. More...

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object. More...

void	HardSelect ()
	HardSelect. More...

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId. More...

virtual int	GetTypeId () override
	GetTypeId( int pTypeId ) More...

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyBool	SystemCamera
	Read Only Property: Indicate if this a producer (default or system) camera or a custom (user-created) camera. More...

FBPropertyCameraFrameSizeMode	FrameSizeMode
	Read Write Property: Frame size standard mode. More...

FBPropertyCameraResolutionMode	ResolutionMode
	Read Write Property: Resolution standard mode. More...

FBPropertyDouble	ResolutionWidth
	Read Write Property: Resolution width. More...

FBPropertyDouble	ResolutionHeight
	Read Write Property: Resolution height. More...

FBPropertyDouble	WindowWidth
	Read Only Property: Window width. More...

FBPropertyDouble	WindowHeight
	Read Only Property: Window height. More...

FBPropertyDouble	PixelAspectRatio
	Read Write Property: Pixel aspect ratio. More...

FBPropertyDouble	NearPlaneDistance
	Read Write Property: Near plane distance. More...

FBPropertyDouble	FarPlaneDistance
	Read Write Property: Far plane distance. More...

FBPropertyBool	MouseLockCamera
	Read Write Property: Mouse lock for camera? More...

FBPropertyCameraType	Type
	Read Write Property: Type of camera More...

FBPropertyCameraApertureMode	ApertureMode
	Read Write Property: Aperture mode. More...

FBPropertyAnimatableDouble	FieldOfView
	Read Write Property: Field of View (used when in horizontal or vertical aperture modes). More...

FBPropertyAnimatableDouble	FieldOfViewX
	Read Write Property: Field of View X angle (used in horizontal and vertical aperture mode). More...

FBPropertyAnimatableDouble	FieldOfViewY
	Read Write Property: Field of View Y angle (used in horizontal and vertical aperture mode). More...

FBPropertyAnimatableDouble	OpticalCenterX
	Read Write Property: Optical Center X (mm). More...

FBPropertyAnimatableDouble	OpticalCenterY
	Read Write Property: Optical Center Y (mm). More...

FBPropertyAnimatableDouble	FocalLength
	Read Write Property: Focal Length. More...

FBPropertyCameraFilmBackType	FilmBackType
	Read Write Property: Film back standard type. More...

FBPropertyDouble	FilmSizeWidth
	Read Write Property: Width of the film. More...

FBPropertyDouble	FilmSizeHeight
	Read Write Property: Height of the film. More...

FBPropertyDouble	FilmAspectRatio
	Read Write Property: Film aspect ratio. More...

FBPropertyDouble	SqueezeRatio
	Read Write Property: Squeeze ratio. More...

FBPropertyDouble	OrthoZoom
	Read Write Property: Zoom factor of an orthographic camera. More...

FBPropertyTexture	BackGroundTexture
	Read Write Property: Background Texture More...

FBPropertyVideo	BackGroundMedia

FBPropertyCameraViewPlaneMode	ViewBackGroundPlaneMode
	Read Write Property: Background plane view mode More...

FBPropertyBool	BackGroundImageCenter
	Read Write Property: Center the background image More...

FBPropertyBool	BackGroundImageFit
	Read Write Property: Fit the background image More...

FBPropertyBool	BackGroundImageKeepRatio
	Read Write Property: Keep the background image's ratio More...

FBPropertyBool	BackGroundImageCrop
	Read Write Property: Crop the background image More...

FBPropertyAnimatableDouble	BackGroundImageOffsetX
	Read Write Property: Ignored if BackGroundImageFit is true. X offset, in term of percentage of the fit background image width, applied on the background image. More...

FBPropertyAnimatableDouble	BackGroundImageOffsetY
	Read Write Property: Ignored if BackGroundImageFit is true. Y offset, in term of percentage of the fit background image height, applied on the background image. More...

FBPropertyAnimatableDouble	BackGroundImageScaleX
	Read Write Property: Ignored if BackGroundImageFit is true. X scale, in term of percentage of the fit background image width, applied on the background image. More...

FBPropertyAnimatableDouble	BackGroundImageScaleY
	Read Write Property: Ignored if BackGroundImageFit and/or BackGroundImageKeepRatio is true. Y scale, in term of percentage of the fit background image height, applied on the background image. The X scale property is considered instead of this Y scale property if BackGroundImageKeepRatio is set to true. More...

FBPropertyDouble	BackGroundPlaneDistance
	Read Write Property: Set the distance for the background plane. More...

FBPropertyCameraDistanceMode	BackGroundPlaneDistanceMode
	Read Write Property: Select mode for the background plane's distance. More...

FBPropertyAnimatableDouble	ForeGroundAlpha
	Read Write Property: Opacity of foreground. More...

FBPropertyDouble	ForeGroundMaterialThreshold
	Read Write Property: Material threshold for a transparent foreground. More...

FBPropertyBool	ForeGroundTransparent
	Read Write Property: Is the foreground transparent? More...

FBPropertyTexture	ForeGroundTexture
	Read Write Property: ForeGround Texture More...

FBPropertyVideo	ForeGroundMedia

FBPropertyCameraViewPlaneMode	ViewForeGroundPlaneMode
	Read Write Property: Foreground plane view mode More...

FBPropertyBool	ForeGroundImageCenter
	Read Write Property: Center the foreground image More...

FBPropertyBool	ForeGroundImageFit
	Read Write Property: Fit the foreground image More...

FBPropertyBool	ForeGroundImageKeepRatio
	Read Write Property: Keep the foreground image's ratio? More...

FBPropertyBool	ForeGroundImageCrop
	Read Write Property: Crop the foreground image More...

FBPropertyAnimatableDouble	ForeGroundImageOffsetX
	Read Write Property: Ignored if ForeGroundImageFit is true. X offset, in term of percentage of the fit foreground image width, applied on the foreground image. More...

FBPropertyAnimatableDouble	ForeGroundImageOffsetY
	Read Write Property: Ignored if ForeGroundImageFit is true. Y offset, in term of percentage of the fit foreground image height, applied on the foreground image. More...

FBPropertyAnimatableDouble	ForeGroundImageScaleX
	Read Write Property: Ignored if ForeGroundImageFit is true. X scale, in term of percentage of the fit foreground image width, applied on the foreground image. More...

FBPropertyAnimatableDouble	ForeGroundImageScaleY
	Read Write Property: Ignored if ForeGroundImageFit and/or ForeGroundImageKeepRatio is true. Y scale, in term of percentage of the fit foreground image height, applied on the foreground image. The X scale property is considered instead of this Y scale property if ForeGroundImageKeepRatio is set to true. More...

FBPropertyDouble	ForeGroundPlaneDistance
	Read Write Property: Set the distance for the foreground plane. More...

FBPropertyCameraDistanceMode	ForeGroundPlaneDistanceMode
	Read Write Property: Select mode for the foreground plane's distance. More...

FBPropertyBool	ViewCameraInterest
	Read Write Property: Show the camera interest? More...

FBPropertyBool	ViewNearFarPlane
	Read Write Property: Show near/far planes? More...

FBPropertyBool	ViewShowName
	Read Write Property: Show name? More...

FBPropertyBool	ViewShowManipulators
	Read Write Property: Show manipulators? More...

FBPropertyBool	ViewShowGrid
	Read Write Property: Show grid? More...

FBPropertyBool	ViewShowAxis
	Read Write Property: Show axis? More...

FBPropertyBool	ViewShowTimeCode
	Read Write Property: Show time code? More...

FBPropertyBool	ViewDisplaySafeArea
	Read Write Property: Display safe area? More...

FBPropertyBool	ViewOpticalCenter
	Read Write Property: View optical center? More...

FBPropertyCameraSafeAreaMode	SafeAreaMode
	Read Write Property: Select mode for safe area. More...

FBPropertyAnimatableColor	BackGroundColor
	Read Write Property: Background color for camera. More...

FBPropertyBool	UseFrameColor
	Read Write Property: Use frame color? More...

FBPropertyColor	FrameColor
	Read Write Property: Frame color for camera. More...

FBPropertyBool	UseAntiAliasing
	Read Write Property: Use anti-aliasing? More...

FBPropertyAnimatableBool	UseDepthOfField
	Read Write Property: Use depth of field calculations? More...

FBPropertyBool	InteractiveMode
	Read Write Property: Interactive mode? More...

FBPropertyDouble	AntiAliasingIntensity
	Read Write Property: Anti-aliasing intensity. More...

FBPropertyCameraAntiAliasingMethod	AntiAliasingMethod
	Read Write Property: Anti-aliasing method. More...

FBPropertyInt	NumberOfSamples
	Read Write Property: Number of samples to oversample with. More...

FBPropertyCameraSamplingType	SamplingType
	Read Write Property: Type of over sampling. More...

FBPropertyBool	UseAccumulationBuffer
	Read Write Property: Use accumulation buffer? More...

FBPropertyCameraFocusDistanceSource	FocusDistanceSource
	Read Write Property: Select source for focusing. More...

FBPropertyAnimatableDouble	FocusSpecificDistance
	Read Write Property: Specfic distance for focusing. More...

FBPropertyModel	FocusModel
	Read Write Property: Another model that determines the focus distance. More...

FBPropertyAnimatableDouble	FocusAngle
	Read Write Property: Focus Angle (rendering dof). More...

FBPropertyBool	Use2DMagnifier
	Read Write Property: Enable/Disable the 2D Magnifier. More...

FBPropertyBool	Display2DMagnifierFrame
	Read Write Property: Enable/Disable the drawing of the 2D Magnifier frame box. More...

FBPropertyAnimatableDouble	MagnifierZoom
	Read Write Property: 2D Magnifier Zoom value. More...

FBPropertyAnimatableDouble	MagnifierPosX
	Read Write Property: 2D Magnifier X Position. More...

FBPropertyAnimatableDouble	MagnifierPosY
	Read Write Property: 2D Magnifier Y Position. More...

FBPropertyModel	Interest
	Read Write Property: Direct camera's interest. More...

FBPropertyAnimatableDouble	Roll
	Read Write Property: Camera's roll on it's Z axis. More...

FBPropertyAnimatableDouble	TurnTable
	Read Write Property: Camera's rotation around its interest. More...

FBPropertyBool	DisplayTurnTableIcon
	Read Write Property: Enable/Disable the drawing of the Turn Table icon. More...

FBPropertyAnimatableDouble	MotionBlurIntensity
	Read Write Property: Motion Blur Intensity. More...

FBPropertyBool	UseMotionBlur
	Read Write Property: Enable Motion Blur. More...

FBPropertyBool	UseRealTimeMotionBlur
	Read Write Property: Enable Real-time Motion Blur. More...

FBPropertyInt	CameraViewportX
	Read Only Property: Camera Viewport start position's X value More...

FBPropertyInt	CameraViewportY
	Read Only Property: Camera Viewport start position's Y value More...

FBPropertyInt	CameraViewportWidth
	Read Only Property: Camera Viewport width More...

FBPropertyInt	CameraViewportHeight
	Read Only Property: Camera Viewport height More...

FBPropertyListHUD	HUDs
	List : HUDs present in this camera More...

Public Attributes inherited from FBModel
FBPropertyListModel	Children
	List: Children for model. More...

FBPropertyListShader	Shaders
	List: Shaders for model. More...

FBPropertyListMaterial	Materials
	List: Materials for model. More...

FBPropertyListTexture	Textures
	List: Textures with Special UseType (Other than "Color" which should connect to materials). More...

FBPropertyListDeformer	Deformers
	List: Deformers (Skeleton Deformer or Point Cache Deformer). More...

FBPropertyBool	Icon3D
	Read Write Property: Is model a 3D icon? More...

FBPropertyBool	SoftSelected
	Read Write Property: Is model Soft selected? More...

FBPropertyBool	IsDeformable
	Read Only Property: Is model deformable? More...

FBPropertyBool	IsConstrained
	Read Only Property: Is model constrained? More...

FBPropertyBool	SkeletonDeformable
	Read Write Property: Model skeleton deformable. Not Savable More...

FBPropertyBool	BlendShapeDeformable
	Read Write Property: Model blend-shape deformable. Not Savable More...

FBPropertyBool	ConstrainDeformable
	Read Write Property: Model constraint deformable. Not Savable More...

FBPropertyBool	PointCacheDeformable
	Read Write Property: Model point cache deformable. Not Savable More...

FBPropertyBool	PointCacheRecord
	Read Write Property: Record Point Cache for model? Not Savable More...

FBPropertyModel	Parent
	Read Write Property: Parent model. More...

FBPropertyModel	LookAt
	Read Write Property: Look at model (interest point). More...

FBPropertyModel	UpVector
	Read Write Property: UpVector model. More...

FBPropertyGeometry	Geometry
	Read Write Property: Geometry for the model. More...

FBPropertyInt	GeometryUpdateId
	Read Only Property: model geometry (vertex data) related update id. More...

FBPropertyMesh	TessellatedMesh
	Read Only Property: Tessellated Mesh for the model. More...

FBPropertyModelVertexData	ModelVertexData
	Read Only Property: ModelVertexData for the model. More...

FBPropertyCluster	Cluster
	Read Only Property: Link Cluster for the model. More...

FBPropertyScene	Scene
	Read Only Property: Scene containing the model. More...

FBPropertyModelShadingMode	ShadingMode
	Read Write Property: Shading mode for the model. More...

FBPropertyAnimationNode	AnimationNode
	Read Only Property: Animation node of the model. More...

FBPropertyModelRotationOrder	RotationOrder
	Read Write Property: Rotation order. More...

FBPropertyBool	RotationSpaceForLimitOnly
	Read Write Property: Apply Post Rotation Matrix only for Limits? More...

FBPropertyBool	RotationActive
	Read Write Property: Is model using Rotation Limits? More...

FBPropertyVector3d	PreRotation
	Read Write Property: Pre Rotation (considered if RotationActive is true) More...

FBPropertyVector3d	PostRotation
	Read Write Property: Post Rotation (considered if RotationActive is true) More...

FBPropertyVector3d	RotationMin
	Read Write Property: Min Rotation Limit (considered if RotationActive is true) More...

FBPropertyVector3d	RotationMax
	Read Write Property: Max Rotation Limit (considered if RotationActive is true) More...

FBPropertyBool	RotationMinX
	Read Write Property: Is model using Minimum Rotation Limits On X? More...

FBPropertyBool	RotationMinY
	Read Write Property: Is model using Minimum Rotation Limits On Y? More...

FBPropertyBool	RotationMinZ
	Read Write Property: Is model using Minimum Rotation Limits On Z? More...

FBPropertyBool	RotationMaxX
	Read Write Property: Is model using Maximum Rotation Limits On X? More...

FBPropertyBool	RotationMaxY
	Read Write Property: Is model using Maximum Rotation Limits On Y? More...

FBPropertyBool	RotationMaxZ
	Read Write Property: Is model using Maximum Rotation Limits On Z? More...

FBPropertyBool	TranslationActive
	Read Write Property: Is model using Translation Limits? More...

FBPropertyVector3d	TranslationMin
	Read Write Property: Translation Limit Min. More...

FBPropertyVector3d	TranslationMax
	Read Write Property: Translation Limit Max. More...

FBPropertyBool	TranslationMinX
	Read Write Property: Is model using Translation Limits on Min X. More...

FBPropertyBool	TranslationMinY
	Read Write Property: Is model using Translation Limits on Min Y. More...

FBPropertyBool	TranslationMinZ
	Read Write Property: Is model using Translation Limits on Min Z. More...

FBPropertyBool	TranslationMaxX
	Read Write Property: Is model using Translation Limits on Max X. More...

FBPropertyBool	TranslationMaxY
	Read Write Property: Is model using Translation Limits on Max Y. More...

FBPropertyBool	TranslationMaxZ
	Read Write Property: Is model using Translation Limits on Max Z. More...

FBPropertyAnimatableBool	Visibility
	Read Write Property: Visibility of model. This can be overridden by the 'Show' property. More...

FBPropertyBool	VisibilityInheritance
	Read Write Property: //!< When this value is set to `True` the Visibility of this model is also applied to all its descendants More...

FBPropertyAnimatableVector3d	Translation
	Read Write Property: Lcl translation. More...

FBPropertyAnimatableVector3d	Rotation
	Read Write Property: Lcl rotation. More...

FBPropertyAnimatableVector3d	Scaling
	Read Write Property: Lcl scaling. More...

FBPropertyVector3d	GeometricTranslation
	Read Write Property: Geometric translation. More...

FBPropertyVector3d	GeometricRotation
	Read Write Property: Geometric rotation. More...

FBPropertyVector3d	GeometricScaling
	Read Write Property: Geometric scaling. More...

FBPropertyBool	QuaternionInterpolate
	Read Write Property: Use quaternion interpolation. More...

FBPropertyBool	Show
	Read Write Property: Indicate if the viewer should show the object, according to its visibility value. This has a default value of 'false'. More...

FBPropertyBool	Pickable
	Read Write Property: Indicate if a model can be picked in the viewer. This has a default value of 'true'. More...

FBPropertyBool	Transformable
	Read Write Property: Indicate if a model can be transformable in the viewer. This has a default value of 'true'. More...

FBPropertyColor	UniqueColorId
	Read Only Property: Unique Color Id for color based viewer picking. Color channel values are in the range [0, 1] with 1.0/255 precision. More...

FBPropertyBool	PrimaryVisibility
	Read Write Property: Control the geometry render state. Geometry can still cast shadows even if this is turned off. More...

FBPropertyBool	CastsShadows
	Read Write Property: If true, the geometry will produce shadows. More...

FBPropertyBool	ReceiveShadows
	Read Write Property: If true, the geometry will receive shadows. More...

Public Attributes inherited from FBBox
const char *	UniqueName
	internal Unique name. More...

FBPropertyBool	Animatable
	Read Write Property: Is the box animatable. More...

FBPropertyBool	Live
	Read Write Property: Is live? More...

FBPropertyBool	RecordMode
	Read Write Property: Is recording? More...

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyListComponent	Components
	List: List of components. More...

FBPropertyListComponent	Parents
	List: Parents. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

FBPropertyString	Name
	Read Write Property: Unique name of object. More...

FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component. More...

Static Public Attributes
static const double	OrthoFactor
	Constant scale factor to be used with OrthoZoom for orthographic cameras. More...

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object. More...

Additional Inherited Members
Public Types inherited from FBBox
enum	ECandidateAction { eCandidateAccept , eCandidateIntercept , eCandidateInterceptAfterEvaluation }
	Resolving action for candidates. More...

Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component. More...

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection. More...

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection. More...

void	DisconnectAllSrc ()
	Remove all source connections. More...

void	DisconnectAllDst ()
	Remove all destination connections. More...

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index. More...

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index. More...

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B. More...

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex. More...

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc. More...

int	GetSrcCount ()
	Get source connection count. More...

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index. More...

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index. More...

int	GetDstCount ()
	Get destination connection count. More...

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index. More...

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index. More...

bool	BeginChange ()
	Begins a change on multiple plugs. More...

void	EndChange ()
	Ends a change on multiple plugs. More...

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed. More...

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status. More...

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag. More...

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed. More...

FBPlug *	GetOwner ()
	Get the owner of this plug. More...

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index. More...

int	GetOwnedCount ()
	Get the owned plug count. More...

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id. More...

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component. More...

HIObject	mObject
	Handle on the Plug. More...

bool	mSDKComponent
	bool Plug is an SDK component. More...

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object. More...

static int	TypeInfo
	TypeInfo. More...

static int	mGlobalTypeInfo
	Represente the Type Index. More...

Detailed Description

Creates custom cameras and manages system cameras.

When you look at a scene in the MotionBuilder Viewer, you are using a camera view.

There are two types of cameras:

Producer cameras. By default one of the producer cameras is used. These are always present. They can be configured but not destroyed.
Custom cameras, created by the user.

The SystemCamera property indicates whether a given camera is a producer or a custom camera.

When you create a camera you should make it visible with the show property (inherited from FBModel).

Use FBCameraSwitcher to get and set the current camera. For usage, see the Python sample CameraSwitcher.py.

To see how to create a camera with a marker as an interest, see the Python sample code in FBCamera.py. For usage in C++, see the manipcamera sample.

Definition at line 206 of file fbcamera.h.

Constructor & Destructor Documentation

◆ FBCamera()

FBCamera	(	const char *	pName,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters

pName	Name of camera.
pObject	For internal use only(default=NULL).

Member Function Documentation

◆ GetCameraMatrix()

void GetCameraMatrix	(	FBMatrix &	pMatrix,
		FBCameraMatrixType	pType,
		FBEvaluateInfo *	pEvalInfo = `NULL`
	)

Obtains the camera's matrix.

Parameters

pMatrix	Matrix to fill with requested information.
pType	Camera Matrix type to obtain.
pEvalInfo	Take Display if none specified.

◆ InverseProjection()

FBVector4d InverseProjection	(	int	pX,
		int	pY,
		double	pDistanceFromCamera,
		bool	pRelativeToViewport = `false`
	)

Returns the world coordinates based on screen coordinates and input distance from the camera.

Parameters

pX	Screen horizontal coordinate in pixel. When pRelativeToViewport is false, the range is between 0 and (WindowWidth - 1). When pRelativeToViewport is true, the range is between 0 to (CameraViewportWidth - 1). The coordinate starts at left of the region.
pY	Screen vertical coordinate in pixel. When pRelativeToViewport is false, the range is between 0 and (WindowHeight - 1). When pRelativeToViewport is true, the range is between 0 to (CameraViewportHeight - 1). The coordinate starts at top of the region.
pDistanceFromCamera	Distance from the camera to the resulting world coordinate position
pRelativeToViewport	true indicates (pX,pY) is relative to the window; false indicates (pX,pY) is relative to the viewport of the camera.

Returns: The world coordinates in 3D space

Member Data Documentation

◆ AntiAliasingIntensity

FBPropertyDouble AntiAliasingIntensity

Read Write Property: Anti-aliasing intensity.

Definition at line 333 of file fbcamera.h.

◆ AntiAliasingMethod

FBPropertyCameraAntiAliasingMethod AntiAliasingMethod

Read Write Property: Anti-aliasing method.

Definition at line 334 of file fbcamera.h.

◆ ApertureMode

FBPropertyCameraApertureMode ApertureMode

Read Write Property: Aperture mode.

Definition at line 229 of file fbcamera.h.

◆ BackGroundColor

FBPropertyAnimatableColor BackGroundColor

Read Write Property: Background color for camera.

Definition at line 322 of file fbcamera.h.

◆ BackGroundImageCenter

FBPropertyBool BackGroundImageCenter

Read Write Property: Center the background image

Definition at line 281 of file fbcamera.h.

◆ BackGroundImageCrop

FBPropertyBool BackGroundImageCrop

Read Write Property: Crop the background image

Definition at line 284 of file fbcamera.h.

◆ BackGroundImageFit

FBPropertyBool BackGroundImageFit

Read Write Property: Fit the background image

Definition at line 282 of file fbcamera.h.

◆ BackGroundImageKeepRatio

FBPropertyBool BackGroundImageKeepRatio

Read Write Property: Keep the background image's ratio

Definition at line 283 of file fbcamera.h.

◆ BackGroundImageOffsetX

FBPropertyAnimatableDouble BackGroundImageOffsetX

Read Write Property: Ignored if BackGroundImageFit is true. X offset, in term of percentage of the fit background image width, applied on the background image.

Definition at line 285 of file fbcamera.h.

◆ BackGroundImageOffsetY

FBPropertyAnimatableDouble BackGroundImageOffsetY

Read Write Property: Ignored if BackGroundImageFit is true. Y offset, in term of percentage of the fit background image height, applied on the background image.

Definition at line 286 of file fbcamera.h.

◆ BackGroundImageScaleX

FBPropertyAnimatableDouble BackGroundImageScaleX

Read Write Property: Ignored if BackGroundImageFit is true. X scale, in term of percentage of the fit background image width, applied on the background image.

Definition at line 287 of file fbcamera.h.

◆ BackGroundImageScaleY

FBPropertyAnimatableDouble BackGroundImageScaleY

Read Write Property: Ignored if BackGroundImageFit and/or BackGroundImageKeepRatio is true. Y scale, in term of percentage of the fit background image height, applied on the background image. The X scale property is considered instead of this Y scale property if BackGroundImageKeepRatio is set to true.

Definition at line 288 of file fbcamera.h.

◆ BackGroundMedia

FBPropertyVideo BackGroundMedia

Deprecated:: Read Write Property: BackGround Image

Definition at line 279 of file fbcamera.h.

◆ BackGroundPlaneDistance

FBPropertyDouble BackGroundPlaneDistance

Read Write Property: Set the distance for the background plane.

Definition at line 289 of file fbcamera.h.

◆ BackGroundPlaneDistanceMode

FBPropertyCameraDistanceMode BackGroundPlaneDistanceMode

Read Write Property: Select mode for the background plane's distance.

Definition at line 290 of file fbcamera.h.

◆ BackGroundTexture

FBPropertyTexture BackGroundTexture

Read Write Property: Background Texture

Definition at line 278 of file fbcamera.h.

◆ CameraViewportHeight

FBPropertyInt CameraViewportHeight

Read Only Property: Camera Viewport height

Definition at line 367 of file fbcamera.h.

◆ CameraViewportWidth

FBPropertyInt CameraViewportWidth

Read Only Property: Camera Viewport width

Definition at line 366 of file fbcamera.h.

◆ CameraViewportX

FBPropertyInt CameraViewportX

Read Only Property: Camera Viewport start position's X value

Definition at line 364 of file fbcamera.h.

◆ CameraViewportY

FBPropertyInt CameraViewportY

Read Only Property: Camera Viewport start position's Y value

Definition at line 365 of file fbcamera.h.

◆ Display2DMagnifierFrame

FBPropertyBool Display2DMagnifierFrame

Read Write Property: Enable/Disable the drawing of the 2D Magnifier frame box.

Definition at line 347 of file fbcamera.h.

◆ DisplayTurnTableIcon

FBPropertyBool DisplayTurnTableIcon

Read Write Property: Enable/Disable the drawing of the Turn Table icon.

Definition at line 356 of file fbcamera.h.

◆ FarPlaneDistance

FBPropertyDouble FarPlaneDistance

Read Write Property: Far plane distance.

Definition at line 226 of file fbcamera.h.

◆ FieldOfView

FBPropertyAnimatableDouble FieldOfView

Read Write Property: Field of View (used when in horizontal or vertical aperture modes).

Definition at line 230 of file fbcamera.h.

◆ FieldOfViewX

FBPropertyAnimatableDouble FieldOfViewX

Read Write Property: Field of View X angle (used in horizontal and vertical aperture mode).

Definition at line 232 of file fbcamera.h.

◆ FieldOfViewY

FBPropertyAnimatableDouble FieldOfViewY

Read Write Property: Field of View Y angle (used in horizontal and vertical aperture mode).

Definition at line 233 of file fbcamera.h.

◆ FilmAspectRatio

FBPropertyDouble FilmAspectRatio

Read Write Property: Film aspect ratio.

Definition at line 241 of file fbcamera.h.

◆ FilmBackType

FBPropertyCameraFilmBackType FilmBackType

Read Write Property: Film back standard type.

Definition at line 238 of file fbcamera.h.

◆ FilmSizeHeight

FBPropertyDouble FilmSizeHeight

Read Write Property: Height of the film.

Definition at line 240 of file fbcamera.h.

◆ FilmSizeWidth

FBPropertyDouble FilmSizeWidth

Read Write Property: Width of the film.

Definition at line 239 of file fbcamera.h.

◆ FocalLength

FBPropertyAnimatableDouble FocalLength

Read Write Property: Focal Length.

Definition at line 236 of file fbcamera.h.

◆ FocusAngle

FBPropertyAnimatableDouble FocusAngle

Read Write Property: Focus Angle (rendering dof).

Definition at line 343 of file fbcamera.h.

◆ FocusDistanceSource

FBPropertyCameraFocusDistanceSource FocusDistanceSource

Read Write Property: Select source for focusing.

Definition at line 340 of file fbcamera.h.

◆ FocusModel

FBPropertyModel FocusModel

Read Write Property: Another model that determines the focus distance.

Definition at line 342 of file fbcamera.h.

◆ FocusSpecificDistance

FBPropertyAnimatableDouble FocusSpecificDistance

Read Write Property: Specfic distance for focusing.

Definition at line 341 of file fbcamera.h.

◆ ForeGroundAlpha

FBPropertyAnimatableDouble ForeGroundAlpha

Read Write Property: Opacity of foreground.

Definition at line 293 of file fbcamera.h.

◆ ForeGroundImageCenter

FBPropertyBool ForeGroundImageCenter

Read Write Property: Center the foreground image

Definition at line 299 of file fbcamera.h.

◆ ForeGroundImageCrop

FBPropertyBool ForeGroundImageCrop

Read Write Property: Crop the foreground image

Definition at line 302 of file fbcamera.h.

◆ ForeGroundImageFit

FBPropertyBool ForeGroundImageFit

Read Write Property: Fit the foreground image

Definition at line 300 of file fbcamera.h.

◆ ForeGroundImageKeepRatio

FBPropertyBool ForeGroundImageKeepRatio

Read Write Property: Keep the foreground image's ratio?

Definition at line 301 of file fbcamera.h.

◆ ForeGroundImageOffsetX

FBPropertyAnimatableDouble ForeGroundImageOffsetX

Read Write Property: Ignored if ForeGroundImageFit is true. X offset, in term of percentage of the fit foreground image width, applied on the foreground image.

Definition at line 303 of file fbcamera.h.

◆ ForeGroundImageOffsetY

FBPropertyAnimatableDouble ForeGroundImageOffsetY

Read Write Property: Ignored if ForeGroundImageFit is true. Y offset, in term of percentage of the fit foreground image height, applied on the foreground image.

Definition at line 304 of file fbcamera.h.

◆ ForeGroundImageScaleX

FBPropertyAnimatableDouble ForeGroundImageScaleX

Read Write Property: Ignored if ForeGroundImageFit is true. X scale, in term of percentage of the fit foreground image width, applied on the foreground image.

Definition at line 305 of file fbcamera.h.

◆ ForeGroundImageScaleY

FBPropertyAnimatableDouble ForeGroundImageScaleY

Read Write Property: Ignored if ForeGroundImageFit and/or ForeGroundImageKeepRatio is true. Y scale, in term of percentage of the fit foreground image height, applied on the foreground image. The X scale property is considered instead of this Y scale property if ForeGroundImageKeepRatio is set to true.

Definition at line 306 of file fbcamera.h.

◆ ForeGroundMaterialThreshold

FBPropertyDouble ForeGroundMaterialThreshold

Read Write Property: Material threshold for a transparent foreground.

Definition at line 294 of file fbcamera.h.

◆ ForeGroundMedia

FBPropertyVideo ForeGroundMedia

Deprecated:: Read Write Property: ForeGround Image

Definition at line 297 of file fbcamera.h.

◆ ForeGroundPlaneDistance

FBPropertyDouble ForeGroundPlaneDistance

Read Write Property: Set the distance for the foreground plane.

Definition at line 307 of file fbcamera.h.

◆ ForeGroundPlaneDistanceMode

FBPropertyCameraDistanceMode ForeGroundPlaneDistanceMode

Read Write Property: Select mode for the foreground plane's distance.

Definition at line 308 of file fbcamera.h.

◆ ForeGroundTexture

FBPropertyTexture ForeGroundTexture

Read Write Property: ForeGround Texture

Definition at line 296 of file fbcamera.h.

◆ ForeGroundTransparent

FBPropertyBool ForeGroundTransparent

Read Write Property: Is the foreground transparent?

Definition at line 295 of file fbcamera.h.

◆ FrameColor

FBPropertyColor FrameColor

Read Write Property: Frame color for camera.

Definition at line 324 of file fbcamera.h.

◆ FrameSizeMode

FBPropertyCameraFrameSizeMode FrameSizeMode

Read Write Property: Frame size standard mode.

Definition at line 218 of file fbcamera.h.

◆ HUDs

FBPropertyListHUD HUDs

List : HUDs present in this camera

Definition at line 370 of file fbcamera.h.

◆ InteractiveMode

FBPropertyBool InteractiveMode

Read Write Property: Interactive mode?

Definition at line 330 of file fbcamera.h.

◆ Interest

FBPropertyModel Interest

Read Write Property: Direct camera's interest.

Definition at line 353 of file fbcamera.h.

◆ MagnifierPosX

FBPropertyAnimatableDouble MagnifierPosX

Read Write Property: 2D Magnifier X Position.

Definition at line 349 of file fbcamera.h.

◆ MagnifierPosY

FBPropertyAnimatableDouble MagnifierPosY

Read Write Property: 2D Magnifier Y Position.

Definition at line 350 of file fbcamera.h.

◆ MagnifierZoom

FBPropertyAnimatableDouble MagnifierZoom

Read Write Property: 2D Magnifier Zoom value.

Definition at line 348 of file fbcamera.h.

◆ MotionBlurIntensity

FBPropertyAnimatableDouble MotionBlurIntensity

Read Write Property: Motion Blur Intensity.

Definition at line 359 of file fbcamera.h.

◆ MouseLockCamera

FBPropertyBool MouseLockCamera

Read Write Property: Mouse lock for camera?

Definition at line 227 of file fbcamera.h.

◆ NearPlaneDistance

FBPropertyDouble NearPlaneDistance

Read Write Property: Near plane distance.

Definition at line 225 of file fbcamera.h.

◆ NumberOfSamples

FBPropertyInt NumberOfSamples

Read Write Property: Number of samples to oversample with.

Definition at line 335 of file fbcamera.h.

◆ OpticalCenterX

FBPropertyAnimatableDouble OpticalCenterX

Read Write Property: Optical Center X (mm).

Definition at line 234 of file fbcamera.h.

◆ OpticalCenterY

FBPropertyAnimatableDouble OpticalCenterY

Read Write Property: Optical Center Y (mm).

Definition at line 235 of file fbcamera.h.

◆ OrthoFactor

const double OrthoFactor

static

Constant scale factor to be used with OrthoZoom for orthographic cameras.

Definition at line 244 of file fbcamera.h.

◆ OrthoZoom

FBPropertyDouble OrthoZoom

Read Write Property: Zoom factor of an orthographic camera.

OrthoZoom is only applicable if the camera has orthographic projection (i.e., Type == FBCameraType::kFBCameraTypeOrthogonal).
This value changes when the orthographic camera is zoomed in or out.
Refer to the following code if you wish to compute the left, right, top, and bottom view planes of the camera.

double lW = mCam.CameraViewportWidth;
double lH = mCam.CameraViewportHeight;
double lPixelRatio = mCam.PixelAspectRatio;
const double lFactor = mCam.OrthoZoom * FBCamera::OrthoFactor;
if( lW < lH )
{
   mLeftPlane   =  -lFactor * lPixelRatio;
   mRightPlane  =   lFactor * lPixelRatio;
   mBottomPlane = -(lFactor * lH) / lW;
   mTopPlane    =  (lFactor * lH) / lW;
}
else
{
   lW *= lPixelRatio;
   mLeftPlane   = -(lFactor * lW) / lH;
   mRightPlane  =  (lFactor * lW) / lH;
   mBottomPlane =  -lFactor;
   mTopPlane    =   lFactor;
}

Definition at line 274 of file fbcamera.h.

◆ PixelAspectRatio

FBPropertyDouble PixelAspectRatio

Read Write Property: Pixel aspect ratio.

Definition at line 224 of file fbcamera.h.

◆ ResolutionHeight

FBPropertyDouble ResolutionHeight

Read Write Property: Resolution height.

Definition at line 221 of file fbcamera.h.

◆ ResolutionMode

FBPropertyCameraResolutionMode ResolutionMode

Read Write Property: Resolution standard mode.

Definition at line 219 of file fbcamera.h.

◆ ResolutionWidth

FBPropertyDouble ResolutionWidth

Read Write Property: Resolution width.

Definition at line 220 of file fbcamera.h.

◆ Roll

FBPropertyAnimatableDouble Roll

Read Write Property: Camera's roll on it's Z axis.

Definition at line 354 of file fbcamera.h.

◆ SafeAreaMode

FBPropertyCameraSafeAreaMode SafeAreaMode

Read Write Property: Select mode for safe area.

Definition at line 320 of file fbcamera.h.

◆ SamplingType

FBPropertyCameraSamplingType SamplingType

Read Write Property: Type of over sampling.

Definition at line 336 of file fbcamera.h.

◆ SqueezeRatio

FBPropertyDouble SqueezeRatio

Read Write Property: Squeeze ratio.

Definition at line 242 of file fbcamera.h.

◆ SystemCamera

FBPropertyBool SystemCamera

Read Only Property: Indicate if this a producer (default or system) camera or a custom (user-created) camera.

Definition at line 215 of file fbcamera.h.

◆ TurnTable

FBPropertyAnimatableDouble TurnTable

Read Write Property: Camera's rotation around its interest.

Definition at line 355 of file fbcamera.h.

◆ Type

FBPropertyCameraType Type

Read Write Property: Type of camera

Definition at line 228 of file fbcamera.h.

◆ Use2DMagnifier

FBPropertyBool Use2DMagnifier

Read Write Property: Enable/Disable the 2D Magnifier.

Definition at line 346 of file fbcamera.h.

◆ UseAccumulationBuffer

FBPropertyBool UseAccumulationBuffer

Read Write Property: Use accumulation buffer?

Definition at line 337 of file fbcamera.h.

◆ UseAntiAliasing

FBPropertyBool UseAntiAliasing

Read Write Property: Use anti-aliasing?

Definition at line 328 of file fbcamera.h.

◆ UseDepthOfField

FBPropertyAnimatableBool UseDepthOfField

Read Write Property: Use depth of field calculations?

Definition at line 329 of file fbcamera.h.

◆ UseFrameColor

FBPropertyBool UseFrameColor

Read Write Property: Use frame color?

Definition at line 323 of file fbcamera.h.

◆ UseMotionBlur

FBPropertyBool UseMotionBlur

Read Write Property: Enable Motion Blur.

Definition at line 360 of file fbcamera.h.

◆ UseRealTimeMotionBlur

FBPropertyBool UseRealTimeMotionBlur

Read Write Property: Enable Real-time Motion Blur.

Definition at line 361 of file fbcamera.h.

◆ ViewBackGroundPlaneMode

FBPropertyCameraViewPlaneMode ViewBackGroundPlaneMode

Read Write Property: Background plane view mode

Definition at line 280 of file fbcamera.h.

◆ ViewCameraInterest

FBPropertyBool ViewCameraInterest

Read Write Property: Show the camera interest?

Definition at line 311 of file fbcamera.h.

◆ ViewDisplaySafeArea

FBPropertyBool ViewDisplaySafeArea

Read Write Property: Display safe area?

Definition at line 318 of file fbcamera.h.

◆ ViewForeGroundPlaneMode

FBPropertyCameraViewPlaneMode ViewForeGroundPlaneMode

Read Write Property: Foreground plane view mode

Definition at line 298 of file fbcamera.h.

◆ ViewNearFarPlane

FBPropertyBool ViewNearFarPlane

Read Write Property: Show near/far planes?

Definition at line 312 of file fbcamera.h.

◆ ViewOpticalCenter

FBPropertyBool ViewOpticalCenter

Read Write Property: View optical center?

Definition at line 319 of file fbcamera.h.

◆ ViewShowAxis

FBPropertyBool ViewShowAxis

Read Write Property: Show axis?

Definition at line 316 of file fbcamera.h.

◆ ViewShowGrid

FBPropertyBool ViewShowGrid

Read Write Property: Show grid?

Definition at line 315 of file fbcamera.h.

◆ ViewShowManipulators

FBPropertyBool ViewShowManipulators

Read Write Property: Show manipulators?

Definition at line 314 of file fbcamera.h.

◆ ViewShowName

FBPropertyBool ViewShowName

Read Write Property: Show name?

Definition at line 313 of file fbcamera.h.

◆ ViewShowTimeCode

FBPropertyBool ViewShowTimeCode

Read Write Property: Show time code?

Definition at line 317 of file fbcamera.h.

◆ WindowHeight

FBPropertyDouble WindowHeight

Read Only Property: Window height.

Definition at line 223 of file fbcamera.h.

◆ WindowWidth

FBPropertyDouble WindowWidth

Read Only Property: Window width.

Definition at line 222 of file fbcamera.h.

The documentation for this class was generated from the following file:

fbcamera.h

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBCamera()

Member Function Documentation

◆ GetCameraMatrix()

◆ InverseProjection()

Member Data Documentation

◆ AntiAliasingIntensity

◆ AntiAliasingMethod

◆ ApertureMode

◆ BackGroundColor

◆ BackGroundImageCenter

◆ BackGroundImageCrop

◆ BackGroundImageFit

◆ BackGroundImageKeepRatio

◆ BackGroundImageOffsetX

◆ BackGroundImageOffsetY

◆ BackGroundImageScaleX

◆ BackGroundImageScaleY

◆ BackGroundMedia

◆ BackGroundPlaneDistance

◆ BackGroundPlaneDistanceMode

◆ BackGroundTexture

◆ CameraViewportHeight

◆ CameraViewportWidth

◆ CameraViewportX

◆ CameraViewportY

◆ Display2DMagnifierFrame

◆ DisplayTurnTableIcon

◆ FarPlaneDistance

◆ FieldOfView

◆ FieldOfViewX

◆ FieldOfViewY

◆ FilmAspectRatio

◆ FilmBackType

◆ FilmSizeHeight

◆ FilmSizeWidth

◆ FocalLength

◆ FocusAngle

◆ FocusDistanceSource

◆ FocusModel

◆ FocusSpecificDistance

◆ ForeGroundAlpha

◆ ForeGroundImageCenter

◆ ForeGroundImageCrop

◆ ForeGroundImageFit

◆ ForeGroundImageKeepRatio

◆ ForeGroundImageOffsetX

◆ ForeGroundImageOffsetY

◆ ForeGroundImageScaleX

◆ ForeGroundImageScaleY

◆ ForeGroundMaterialThreshold

◆ ForeGroundMedia

◆ ForeGroundPlaneDistance

◆ ForeGroundPlaneDistanceMode

◆ ForeGroundTexture

◆ ForeGroundTransparent

◆ FrameColor

◆ FrameSizeMode

◆ HUDs

◆ InteractiveMode

◆ Interest

◆ MagnifierPosX

◆ MagnifierPosY

◆ MagnifierZoom

◆ MotionBlurIntensity

◆ MouseLockCamera

◆ NearPlaneDistance

◆ NumberOfSamples

◆ OpticalCenterX

◆ OpticalCenterY

◆ OrthoFactor

◆ OrthoZoom

◆ PixelAspectRatio

◆ ResolutionHeight

◆ ResolutionMode