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

#include <pyfbsdk_generated.h>

Inheritance diagram for FBCamera:

[legend]

Public Member Functions
	FBCamera (str pName)
	Constructor.

	GetCameraMatrix (FBMatrix pMatrix, FBCameraMatrixType pType, FBEvaluateInfo pEvalInfo=None)
	Obtains the camera's matrix.

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

Public Member Functions inherited from FBModel
	FBModel (str pName)
	Constructor.

FBModel	Clone ()
	Clone the model.

	CollapseInSchematic ()
	Collapse the model in the schematic view.

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

	ExpandInSchematic ()
	Expand the model in the schematic view.

	FBDelete ()
	Open Reality deletion function.

str	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Default', 'Mesh'.

str	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Model'.

	ForceAlwaysEvaluate ()
	Force Always Evaluate.

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

unsigned int	GetAdditionalUniqueColorIDCount ()
	Get additional unique color count.

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

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

	GetLocalTransformationMatrixWithGlobalRotationDoF (FBMatrix pMatrix, bool pInverse=False, FBEvaluateInfo pEvaluateInfo=None)
	Get the local transformation (or local inverse transformation) matrix with the global Rotation DoF values from the model.

	GetMatrix (FBMatrix pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=True, FBEvaluateInfo pEvaluateInfo=None)
	Get a matrix from the model.

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

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

	GetVector (FBVector3d pVector, FBModelTransformationType pWhat=kModelTranslation, bool pGlobalInfo=True, FBEvaluateInfo pEvaluateInfo=None)
	Get a vector from the model.

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

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

bool	IsForceAlwaysEvaluate ()
	Return Force Always Evaluate status.

bool	IsVisible (FBEvaluateInfo pEvaluateInfo=None)
	If the model is visible.

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

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

int	NoFrustumCullingRelease ()
	Release no frustum culling request.

int	NoFrustumCullingRequire ()
	Acquire no frustum culling request.

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

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

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

	SetMatrix (FBMatrix pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=True, bool pPushUndo=False, FBEvaluateInfo pEvaluateInfo=None)
	Set a matrix for the model.

	SetMatrixWithPrecision (FBMatrix pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=True, bool pPushUndo=False, FBEvaluateInfo pEvaluateInfo=None, float pPrecision=FBMat2EulerDegenerateForPrecision10)
	Set a matrix for the model.

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

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

	SetVector (FBVector3d pVector, FBModelTransformationType pWhat=kModelTranslation, bool pGlobalInfo=True, bool pPushUndo=False, FBEvaluateInfo pEvaluateInfo=None)
	Set a vector for the model.

	SetupPropertiesForShapes ()
	Setup Shape Properties.

bool	UseFrustumCulling ()
	Get the current Frustum Culling Status.

Public Member Functions inherited from FBBox
	FBBox (str pName)
	Constructor.

bool	AnimationNodeDestroy (FBAnimationNode pAnimationNode)
	Destroy an animation node.

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

bool	AnimationNodeIsUserData (FBAnimationNode pAnimationNode)
	Is the animation node user data?

FBAnimationNode	AnimationNodeOutGet ()

str	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.

str	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.

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

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

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

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

Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.

str	ClassName ()
	Get the class name.

	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

bool	FBCreate ()
	Open Reality Creation function.

	FBDelete ()
	Open Reality deletion function.

	FBDestroy ()
	Open Reality destruction function.

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

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

FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.

	HardSelect ()
	HardSelect.

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

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

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.

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

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

FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.

	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

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

	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

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

Public Attributes
float	AntiAliasingIntensity
	Read Write Property: Anti-aliasing intensity.

FBCameraAntiAliasingMethod	AntiAliasingMethod
	Read Write Property: Anti-aliasing method.

FBCameraApertureMode	ApertureMode
	Read Write Property: Aperture mode.

FBAnimatableColor	BackGroundColor
	Read Write Property: Background color for camera.

bool	BackGroundImageCenter
	Read Write Property: Center the background image

bool	BackGroundImageCrop
	Read Write Property: Crop the background image

bool	BackGroundImageFit
	Read Write Property: Fit the background image

bool	BackGroundImageKeepRatio
	Read Write Property: Keep the background image's ratio

FBAnimatableDouble	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.

FBAnimatableDouble	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.

FBAnimatableDouble	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.

FBAnimatableDouble	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.

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

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

FBTexture	BackGroundTexture
	Read Write Property: Background Texture

int	CameraViewportHeight
	Read Only Property: Camera Viewport height

int	CameraViewportWidth
	Read Only Property: Camera Viewport width

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

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

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

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

float	FarPlaneDistance
	Read Write Property: Far plane distance.

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

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

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

float	FilmAspectRatio
	Read Write Property: Film aspect ratio.

FBCameraFilmBackType	FilmBackType
	Read Write Property: Film back standard type.

float	FilmSizeHeight
	Read Write Property: Height of the film.

float	FilmSizeWidth
	Read Write Property: Width of the film.

FBAnimatableDouble	FocalLength
	Read Write Property: Focal Length.

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

FBCameraFocusDistanceSource	FocusDistanceSource
	Read Write Property: Select source for focusing.

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

FBAnimatableDouble	FocusSpecificDistance
	Read Write Property: Specfic distance for focusing.

FBAnimatableDouble	ForeGroundAlpha
	Read Write Property: Opacity of foreground.

bool	ForeGroundImageCenter
	Read Write Property: Center the foreground image

bool	ForeGroundImageCrop
	Read Write Property: Crop the foreground image

bool	ForeGroundImageFit
	Read Write Property: Fit the foreground image

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

FBAnimatableDouble	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.

FBAnimatableDouble	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.

FBAnimatableDouble	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.

FBAnimatableDouble	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.

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

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

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

FBTexture	ForeGroundTexture
	Read Write Property: ForeGround Texture

bool	ForeGroundTransparent
	Read Write Property: Is the foreground transparent?

FBColor	FrameColor
	Read Write Property: Frame color for camera.

FBCameraFrameSizeMode	FrameSizeMode
	Read Write Property: Frame size standard mode.

FBListHUD	HUDs
	List : HUDs present in this camera

bool	InteractiveMode
	Read Write Property: Interactive mode?

FBModel	Interest
	Read Write Property: Direct camera's interest.

FBAnimatableDouble	MagnifierPosX
	Read Write Property: 2D Magnifier X Position.

FBAnimatableDouble	MagnifierPosY
	Read Write Property: 2D Magnifier Y Position.

FBAnimatableDouble	MagnifierZoom
	Read Write Property: 2D Magnifier Zoom value.

FBAnimatableDouble	MotionBlurIntensity
	Read Write Property: Motion Blur Intensity.

bool	MouseLockCamera
	Read Write Property: Mouse lock for camera?

float	NearPlaneDistance
	Read Write Property: Near plane distance.

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

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

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

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

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

float	PixelAspectRatio
	Read Write Property: Pixel aspect ratio.

float	ResolutionHeight
	Read Write Property: Resolution height.

FBCameraResolutionMode	ResolutionMode
	Read Write Property: Resolution standard mode.

float	ResolutionWidth
	Read Write Property: Resolution width.

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

FBCameraSafeAreaMode	SafeAreaMode
	Read Write Property: Select mode for safe area.

FBCameraSamplingType	SamplingType
	Read Write Property: Type of over sampling.

float	SqueezeRatio
	Read Write Property: Squeeze ratio.

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

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

FBCameraType	Type
	Read Write Property: Type of camera

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

bool	UseAccumulationBuffer
	Read Write Property: Use accumulation buffer?

bool	UseAntiAliasing
	Read Write Property: Use anti-aliasing?

FBAnimatableBool	UseDepthOfField
	Read Write Property: Use depth of field calculations?

bool	UseFrameColor
	Read Write Property: Use frame color?

bool	UseMotionBlur
	Read Write Property: Enable Motion Blur.

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

FBCameraViewPlaneMode	ViewBackGroundPlaneMode
	Read Write Property: Background plane view mode

bool	ViewCameraInterest
	Read Write Property: Show the camera interest?

bool	ViewDisplaySafeArea
	Read Write Property: Display safe area?

FBCameraViewPlaneMode	ViewForeGroundPlaneMode
	Read Write Property: Foreground plane view mode

bool	ViewNearFarPlane
	Read Write Property: Show near/far planes?

bool	ViewOpticalCenter
	Read Write Property: View optical center?

bool	ViewShowAxis
	Read Write Property: Show axis?

bool	ViewShowGrid
	Read Write Property: Show grid?

bool	ViewShowManipulators
	Read Write Property: Show manipulators?

bool	ViewShowName
	Read Write Property: Show name?

bool	ViewShowTimeCode
	Read Write Property: Show time code?

float	WindowHeight
	Read Only Property: Window height.

float	WindowWidth
	Read Only Property: Window width.

Public Attributes inherited from FBModel
FBAnimationNode	AnimationNode
	Read Only Property: Animation node of the model.

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

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

FBListModel	Children
	List: Children for model.

bool	ConstrainDeformable
	Read Write Property: Model constraint deformable. Not Savable

FBListDeformer	Deformers
	List: Deformers (Skeleton Deformer or Point Cache Deformer).

FBVector3d	GeometricRotation
	Read Write Property: Geometric rotation.

FBVector3d	GeometricScaling
	Read Write Property: Geometric scaling.

FBVector3d	GeometricTranslation
	Read Write Property: Geometric translation.

FBGeometry	Geometry
	Read Write Property: Geometry for the model.

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

bool	Icon3D
	Read Write Property: Is model a 3D icon?

bool	IsConstrained
	Read Only Property: Is model constrained?

bool	IsDeformable
	Read Only Property: Is model deformable?

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

FBListMaterial	Materials
	List: Materials for model.

FBModelVertexData	ModelVertexData
	Read Only Property: ModelVertexData for the model.

FBModel	Parent
	Read Write Property: Parent model.

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

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

bool	PointCacheRecord
	Read Write Property: Record Point Cache for model? Not Savable

FBVector3d	PostRotation
	Read Write Property: Post Rotation (considered if RotationActive is true)

FBVector3d	PreRotation
	Read Write Property: Pre Rotation (considered if RotationActive is true)

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

bool	QuaternionInterpolate
	Read Write Property: Use quaternion interpolation.

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

FBAnimatableVector3d	Rotation
	Read Write Property: Lcl rotation.

bool	RotationActive
	Read Write Property: Is model using Rotation Limits?

FBVector3d	RotationMax
	Read Write Property: Max Rotation Limit (considered if RotationActive is true)

bool	RotationMaxX
	Read Write Property: Is model using Maximum Rotation Limits On X?

bool	RotationMaxY
	Read Write Property: Is model using Maximum Rotation Limits On Y?

bool	RotationMaxZ
	Read Write Property: Is model using Maximum Rotation Limits On Z?

FBVector3d	RotationMin
	Read Write Property: Min Rotation Limit (considered if RotationActive is true)

bool	RotationMinX
	Read Write Property: Is model using Minimum Rotation Limits On X?

bool	RotationMinY
	Read Write Property: Is model using Minimum Rotation Limits On Y?

bool	RotationMinZ
	Read Write Property: Is model using Minimum Rotation Limits On Z?

FBModelRotationOrder	RotationOrder
	Read Write Property: Rotation order.

bool	RotationSpaceForLimitOnly
	Read Write Property: Apply Post Rotation Matrix only for Limits?

FBAnimatableVector3d	Scaling
	Read Write Property: Lcl scaling.

FBScene	Scene
	Read Only Property: Scene containing the model.

FBListShader	Shaders
	List: Shaders for model.

FBModelShadingMode	ShadingMode
	Read Write Property: Shading mode for the model.

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

bool	SkeletonDeformable
	Read Write Property: Model skeleton deformable. Not Savable

bool	SoftSelected
	Read Write Property: Is model Soft selected?

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

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

FBAnimatableVector3d	Translation
	Read Write Property: Lcl translation.

FBColor	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.

FBModel	UpVector
	Read Write Property: UpVector model.

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

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

Public Attributes inherited from FBBox
bool	Animatable
	Read Write Property: Is the box animatable.

bool	Live
	Read Write Property: Is live?

bool	RecordMode
	Read Write Property: Is recording?

str	UniqueName
	internal Unique name.

Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.

str	LongName
	Read Write Property: Name and namespace for object.

str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.

FBListComponent	Parents
	List: Parents.

FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

bool	Selected
	Read Write Property: Selected property.

int	TypeInfo
	Contains the Type information of the object.

Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.

int	TypeInfo
	TypeInfo.

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.

See samples: NewCamera.py, RenderLayers.py, CameraSwitcher.py, SetAllCamerasBackgroundColor.py, SetAllCamerasBackgroundColorFromCurrentCamera.py, SetAllCamerasBackgroundColorFromFirstSelectedCamera.py, FBCamera.py.

Constructor & Destructor Documentation

◆ FBCamera()

FBCamera ( str pName )

Constructor.

Parameters

pName Name of camera.

Member Function Documentation

◆ GetCameraMatrix()

GetCameraMatrix	(	FBMatrix	pMatrix,
		FBCameraMatrixType	pType,
		FBEvaluateInfo	pEvalInfo = `None`
	)

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,
		float	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

float AntiAliasingIntensity

Read Write Property: Anti-aliasing intensity.

◆ AntiAliasingMethod

FBCameraAntiAliasingMethod AntiAliasingMethod

Read Write Property: Anti-aliasing method.

◆ ApertureMode

FBCameraApertureMode ApertureMode

Read Write Property: Aperture mode.

◆ BackGroundColor

FBAnimatableColor BackGroundColor

Read Write Property: Background color for camera.

◆ BackGroundImageCenter

bool BackGroundImageCenter

Read Write Property: Center the background image

◆ BackGroundImageCrop

bool BackGroundImageCrop

Read Write Property: Crop the background image

◆ BackGroundImageFit

bool BackGroundImageFit

Read Write Property: Fit the background image

◆ BackGroundImageKeepRatio

bool BackGroundImageKeepRatio

Read Write Property: Keep the background image's ratio

◆ BackGroundImageOffsetX

FBAnimatableDouble 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.

◆ BackGroundImageOffsetY

FBAnimatableDouble 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.

◆ BackGroundImageScaleX

FBAnimatableDouble 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.

◆ BackGroundImageScaleY

FBAnimatableDouble 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.

◆ BackGroundPlaneDistance

float BackGroundPlaneDistance

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

◆ BackGroundPlaneDistanceMode

FBCameraDistanceMode BackGroundPlaneDistanceMode

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

◆ BackGroundTexture

FBTexture BackGroundTexture

Read Write Property: Background Texture

◆ CameraViewportHeight

int CameraViewportHeight

Read Only Property: Camera Viewport height

◆ CameraViewportWidth

int CameraViewportWidth

Read Only Property: Camera Viewport width

◆ CameraViewportX

int CameraViewportX

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

◆ CameraViewportY

int CameraViewportY

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

◆ Display2DMagnifierFrame

bool Display2DMagnifierFrame

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

◆ DisplayTurnTableIcon

bool DisplayTurnTableIcon

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

◆ FarPlaneDistance

float FarPlaneDistance

Read Write Property: Far plane distance.

◆ FieldOfView

FBAnimatableDouble FieldOfView

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

◆ FieldOfViewX

FBAnimatableDouble FieldOfViewX

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

◆ FieldOfViewY

FBAnimatableDouble FieldOfViewY

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

◆ FilmAspectRatio

float FilmAspectRatio

Read Write Property: Film aspect ratio.

◆ FilmBackType

FBCameraFilmBackType FilmBackType

Read Write Property: Film back standard type.

◆ FilmSizeHeight

float FilmSizeHeight

Read Write Property: Height of the film.

◆ FilmSizeWidth

float FilmSizeWidth

Read Write Property: Width of the film.

◆ FocalLength

FBAnimatableDouble FocalLength

Read Write Property: Focal Length.

◆ FocusAngle

FBAnimatableDouble FocusAngle

Read Write Property: Focus Angle (rendering dof).

◆ FocusDistanceSource

FBCameraFocusDistanceSource FocusDistanceSource

Read Write Property: Select source for focusing.

◆ FocusModel

FBModel FocusModel

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

◆ FocusSpecificDistance

FBAnimatableDouble FocusSpecificDistance

Read Write Property: Specfic distance for focusing.

◆ ForeGroundAlpha

FBAnimatableDouble ForeGroundAlpha

Read Write Property: Opacity of foreground.

◆ ForeGroundImageCenter

bool ForeGroundImageCenter

Read Write Property: Center the foreground image

◆ ForeGroundImageCrop

bool ForeGroundImageCrop

Read Write Property: Crop the foreground image

◆ ForeGroundImageFit

bool ForeGroundImageFit

Read Write Property: Fit the foreground image

◆ ForeGroundImageKeepRatio

bool ForeGroundImageKeepRatio

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

◆ ForeGroundImageOffsetX

FBAnimatableDouble 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.

◆ ForeGroundImageOffsetY

FBAnimatableDouble 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.

◆ ForeGroundImageScaleX

FBAnimatableDouble 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.

◆ ForeGroundImageScaleY

FBAnimatableDouble 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.

◆ ForeGroundMaterialThreshold

float ForeGroundMaterialThreshold

Read Write Property: Material threshold for a transparent foreground.

◆ ForeGroundPlaneDistance

float ForeGroundPlaneDistance

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

◆ ForeGroundPlaneDistanceMode

FBCameraDistanceMode ForeGroundPlaneDistanceMode

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

◆ ForeGroundTexture

FBTexture ForeGroundTexture

Read Write Property: ForeGround Texture

◆ ForeGroundTransparent

bool ForeGroundTransparent

Read Write Property: Is the foreground transparent?

◆ FrameColor

FBColor FrameColor

Read Write Property: Frame color for camera.

◆ FrameSizeMode

FBCameraFrameSizeMode FrameSizeMode

Read Write Property: Frame size standard mode.

◆ HUDs

FBListHUD HUDs

List : HUDs present in this camera

◆ InteractiveMode

bool InteractiveMode

Read Write Property: Interactive mode?

◆ Interest

FBModel Interest

Read Write Property: Direct camera's interest.

◆ MagnifierPosX

FBAnimatableDouble MagnifierPosX

Read Write Property: 2D Magnifier X Position.

◆ MagnifierPosY

FBAnimatableDouble MagnifierPosY

Read Write Property: 2D Magnifier Y Position.

◆ MagnifierZoom

FBAnimatableDouble MagnifierZoom

Read Write Property: 2D Magnifier Zoom value.

◆ MotionBlurIntensity

FBAnimatableDouble MotionBlurIntensity

Read Write Property: Motion Blur Intensity.

◆ MouseLockCamera

bool MouseLockCamera

Read Write Property: Mouse lock for camera?

◆ NearPlaneDistance

float NearPlaneDistance

Read Write Property: Near plane distance.

◆ NumberOfSamples

int NumberOfSamples

Read Write Property: Number of samples to oversample with.

◆ OpticalCenterX

FBAnimatableDouble OpticalCenterX

Read Write Property: Optical Center X (mm).

◆ OpticalCenterY

FBAnimatableDouble OpticalCenterY

Read Write Property: Optical Center Y (mm).

◆ OrthoFactor

float OrthoFactor

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

◆ OrthoZoom

float OrthoZoom

Read Write Property: Zoom factor of an orthographic camera.

◆ PixelAspectRatio

float PixelAspectRatio

Read Write Property: Pixel aspect ratio.

◆ ResolutionHeight

float ResolutionHeight

Read Write Property: Resolution height.

◆ ResolutionMode

FBCameraResolutionMode ResolutionMode

Read Write Property: Resolution standard mode.

◆ ResolutionWidth

float ResolutionWidth

Read Write Property: Resolution width.

◆ Roll

FBAnimatableDouble Roll

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

◆ SafeAreaMode

FBCameraSafeAreaMode SafeAreaMode

Read Write Property: Select mode for safe area.

◆ SamplingType

FBCameraSamplingType SamplingType

Read Write Property: Type of over sampling.

◆ SqueezeRatio

float SqueezeRatio

Read Write Property: Squeeze ratio.

◆ SystemCamera

bool SystemCamera

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

◆ TurnTable

FBAnimatableDouble TurnTable

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

◆ Type

FBCameraType Type

Read Write Property: Type of camera

◆ Use2DMagnifier

bool Use2DMagnifier

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

◆ UseAccumulationBuffer

bool UseAccumulationBuffer

Read Write Property: Use accumulation buffer?

◆ UseAntiAliasing

bool UseAntiAliasing

Read Write Property: Use anti-aliasing?

◆ UseDepthOfField

FBAnimatableBool UseDepthOfField

Read Write Property: Use depth of field calculations?

◆ UseFrameColor

bool UseFrameColor

Read Write Property: Use frame color?

◆ UseMotionBlur

bool UseMotionBlur

Read Write Property: Enable Motion Blur.

◆ UseRealTimeMotionBlur

bool UseRealTimeMotionBlur

Read Write Property: Enable Real-time Motion Blur.

◆ ViewBackGroundPlaneMode

FBCameraViewPlaneMode ViewBackGroundPlaneMode

Read Write Property: Background plane view mode

◆ ViewCameraInterest

bool ViewCameraInterest

Read Write Property: Show the camera interest?

◆ ViewDisplaySafeArea

bool ViewDisplaySafeArea

Read Write Property: Display safe area?

◆ ViewForeGroundPlaneMode

FBCameraViewPlaneMode ViewForeGroundPlaneMode

Read Write Property: Foreground plane view mode

◆ ViewNearFarPlane

bool ViewNearFarPlane

Read Write Property: Show near/far planes?

◆ ViewOpticalCenter

bool ViewOpticalCenter

Read Write Property: View optical center?

◆ ViewShowAxis

bool ViewShowAxis

Read Write Property: Show axis?

◆ ViewShowGrid

bool ViewShowGrid

Read Write Property: Show grid?

◆ ViewShowManipulators

bool ViewShowManipulators

Read Write Property: Show manipulators?

◆ ViewShowName

bool ViewShowName

Read Write Property: Show name?

◆ ViewShowTimeCode

bool ViewShowTimeCode

Read Write Property: Show time code?

◆ WindowHeight

float WindowHeight

Read Only Property: Window height.

◆ WindowWidth

float WindowWidth

Read Only Property: Window width.

Public Member Functions

Public Attributes

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

◆ 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

◆ ForeGroundPlaneDistance

◆ ForeGroundPlaneDistanceMode

◆ ForeGroundTexture

◆ ForeGroundTransparent

◆ FrameColor

◆ FrameSizeMode

◆ HUDs

◆ InteractiveMode

◆ Interest

◆ MagnifierPosX

◆ MagnifierPosY

◆ MagnifierZoom

◆ MotionBlurIntensity

◆ MouseLockCamera

◆ NearPlaneDistance

◆ NumberOfSamples

◆ OpticalCenterX

◆ OpticalCenterY

◆ OrthoFactor

◆ OrthoZoom

◆ PixelAspectRatio

◆ ResolutionHeight

◆ ResolutionMode

◆ ResolutionWidth

◆ Roll

◆ SafeAreaMode

◆ SamplingType