FBCameraStereo Class Reference
 
 
 
FBCameraStereo Class Reference

This reference page is linked to from the following overview topics: FBCamera - Cameras.


#include <fbcamera.h>


Class Description

Definition at line 403 of file fbcamera.h.

Inheritance diagram for FBCameraStereo:
FBCamera FBModel FBBox FBComponent FBPlug FBWrapperHolder

Public Member Functions

  FBCameraStereo (const char *pName, HIObject pObject=NULL)
  Constructor.
K_DEPRECATED_2014 double *  GetMatrix (FBCameraMatrixType pType)
  Obtains the camera's matrix.
void  GetMatrix (FBMatrix &pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=true, FBEvaluateInfo *pEvaluateInfo=NULL)
  Get a matrix from the model.
void  GetCameraMatrix (FBMatrix &pMatrix, FBCameraMatrixType pType, FBEvaluateInfo *pEvalInfo=NULL)
  Obtains the camera's matrix.
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.
virtual void  FBDelete ()
  Open Reality deletion function.
  IQuery_Declare (K_IMPLEMENTATION)
  Interface to IObject.
  ICallback_Declare (K_IMPLEMENTATION)
  Interface to ICallback.
virtual FBModel Clone ()
  Clone the model.
void  SetMatrix (FBMatrix pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=true, bool pPushUndo=false, FBEvaluateInfo *pEvaluateInfo=NULL)
  Set a matrix for the model.
void  SetVector (FBVector3d pVector, FBModelTransformationType pWhat=kModelTranslation, bool pGlobalInfo=true, bool pPushUndo=false, FBEvaluateInfo *pEvaluateInfo=NULL)
  Set a vector for the model.
void  GetVector (FBVector3d &pVector, FBModelTransformationType pWhat=kModelTranslation, bool pGlobalInfo=true, FBEvaluateInfo *pEvaluateInfo=NULL)
  Get a vector from the model.
bool  IsEvaluationReady (FBModelEvaluationTaskType pWhat, FBEvaluateInfo *pEvaluateInfo=NULL) const
  Is the model's evaluation task result ready.
void  MatrixToRotation (FBRVector &pRotation, const FBMatrix &pMatrix)
  Convert Rotation Matrix to Euler Vector based on model's rotation order.
void  RotationToMatrix (FBMatrix &pMatrix, const FBRVector &pRotation)
  Convert Euler Vector to Rotation Matrix based on model's rotation order.
void  LRMToDof (FBRVector &pDof, const FBMatrix &pLM)
  Convert local matrix to object space vector.
void  DofToLRM (FBMatrix &pLM, const FBRVector &pDof)
  Convert object space vector to local matrix.
void  SetSchematicPosition (int pX, int pY)
  Set the position in the schematic view for the model.
void  SetSchematicPosition (FBVector2d pVector2d)
  Set the position in the schematic view for the model.
FBVector2d  GetSchematicPosition ()
  Get the position in the schematic view for the model.
void  GetBoundingBox (FBVector3d &pMin, FBVector3d &pMax)
  Get the bounding box of the model.
bool  IsVisible (FBEvaluateInfo *pEvaluateInfo=NULL)
  If the model is visible.
FBModelCullingMode  GetCullingMode () const
  Get Model Culling Mode.
void  SetCullingMode (FBModelCullingMode pCullingMode)
  Set Model Cullin Mode.
void  ForceAlwaysEvaluate ()
  Force Always Evaluate.
bool  IsForceAlwaysEvaluate ()
  Return Force Always Evaluate status.
int  NoFrustumCullingRequire ()
  Acquire no frustum culling request.
int  NoFrustumCullingRelease ()
  Release no frustum culling request.
bool  UseFrustumCulling ()
  Get the current Frustum Culling Status.
virtual bool  HasCustomDisplay ()
  Function to overload to handle custom display.
virtual void  CustomModelDisplay (FBCamera *pCamera, FBModelShadingMode pShadingMode, FBModelRenderPass pRenderPass, float pPickingAreaWidth, float pPickingAreaHeight)
  Custom display function, called when HasCustomDisplay returns true;.
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;.
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.
unsigned char *  GetSelectedPoints ()
  Get the list of the points selection state.
int  GetSelectedPointsCount ()
  Get the number of selected points in the model.
virtual bool  EvaluateAnimationNodes (FBEvaluateInfo *pEvaluateInfo)
  Evaluation of non TRS nodes that needs to be evaluated.
virtual bool  AnimationNodeNotify (FBAnimationNode *pAnimationNode, FBEvaluateInfo *pEvaluateInfo)
  Notification function for animation thread.
virtual bool  AnimationNodeDestroy (FBAnimationNode *pAnimationNode)
  Destroy an animation node.
virtual bool  AnimationNodeIsUserData (FBAnimationNode *pAnimationNode)
  Is the animation node user data?
virtual void  AnimationNodesOutDisableIfNotWritten (FBEvaluateInfo *pEvaluateInfo)
  This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo.
  IObject_Declare (K_IMPLEMENTATION)
virtual bool  FBCreate ()
  Open Reality Creation function.
virtual void  FBDestroy ()
  Open Reality destruction function.
virtual bool  SetHIObject (HIObject pObject, bool pSDKComponent) override
  Assign component to an internal pointer.
virtual 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.
void  PropertyRemove (FBProperty *pProperty)
  Remove a Property from the component's Property manager.
void  PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
  Get list of properties which have been modified since last loading.
FBProperty PropertyCreate (const char *pName, FBPropertyType pType, const char *pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
  Create user or dynamic property.
FBObjectFlag  GetObjectFlags ()
  Get all Object Flags (concatenated).
void  SetObjectFlags (FBObjectFlag pFlags)
  SetObjectFlags.
bool  HasObjectFlags (FBObjectFlag pFlags)
  Check whether a specific object flag is enabled.
void  EnableObjectFlags (FBObjectFlag pFlags)
  Enable a specific Object Flags.
void  DisableObjectFlags (FBObjectFlag pFlags)
  Disable a specific Object Flags.
void  SetObjectStatus (FBObjectStatus pStatus, bool pValue)
  Enable/Disable a specific Object Status.
bool  GetObjectStatus (FBObjectStatus pStatus)
  Check to see if an object status is enabled.
bool  ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
  ProcessNamespaceHierarchy.
bool  ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
  ProcessObjectNamespace.
virtual const char *  ClassName () override
  Get the class name.
virtual bool  UseCustomPropertyViewSet () const
  Use the custom property viewSet or not.
const char *  GetFullName (void)
  Get the full name.
void  SetOwnerNamespace (FBNamespace *pOwnerNSObj)
  Set the owner Namespace object.
FBNamespace GetOwnerNamespace (void)
  Get the owner Namespace object.
FBFileReference GetOwnerFileReference (void)
  Get the owner FileReference object.
void  HardSelect ()
  HardSelect.
virtual bool  Is (int pTypeId)
  Returns true if object is of type TypeId.
virtual int  GetTypeId ()
  GetTypeId( int pTypeId )
void  KObjectEvent (HIRegister pView, HKEventBase pEvent)
virtual HIObject  GetHIObject () const
  Return an internal pointer.
bool  IsSDKComponent ()
  Return whether or not item is an SDK component.
bool  ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a source connection.
bool  ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a destination connection.
bool  ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a source connection.
bool  ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a destination connection.
bool  DisconnectDst (FBPlug *pDst)
  Remove a destination connection.
bool  DisconnectSrc (FBPlug *pSrc)
  Remove a source connection.
void  DisconnectAllSrc ()
  Remove all source connections.
void  DisconnectAllDst ()
  Remove all destination connections.
bool  DisconnectDstAt (int pIndex)
  Remove a destination connection at a specified index.
bool  DisconnectSrcAt (int pIndex)
  Remove a source connection at a specified index.
bool  ReplaceDstAt (int pIndex, FBPlug *pDst)
  Replace a destination connection at a specified index.
bool  ReplaceSrcAt (int pIndex, FBPlug *pSrc)
  Replace a source connection at a specified index.
bool  SwapSrc (int pIndexA, int pIndexB)
  Swap source connection at index A with source connection at index B.
bool  MoveSrcAt (int pIndex, int pAtIndex)
  Move source connection at pIndex to pAtIndex.
bool  MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc)
  Move source connection pSrc to the position of pAtSrc.
int  GetSrcCount ()
  Get source connection count.
FBPlug GetSrc (int pIndex)
  Get a source connection's plug at specified index.
FBConnectionType  GetSrcType (int pIndex)
  Get a source connection's type at specified index.
int  GetDstCount ()
  Get destination connection count.
FBPlug GetDst (int pIndex)
  Get a destination connection's plug at specified index.
FBConnectionType  GetDstType (int pIndex)
  Get a destination connection's type at specified index.
bool  BeginChange ()
  Begins a change on multiple plugs.
void  EndChange ()
  Ends a change on multiple plugs.
void  SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
  Set the plug's self modification flag.
bool  GetSelfModified (FBPlugModificationFlag pFlag)
  Tell if the plug's self has changed.
void  SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
  Set the plug's owned property/object's modification flag.
bool  GetContentModified (FBPlugModificationFlag pFlag)
  Tell if the plug's content has changed.
int  GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
  Get plug's modified src/dst property/object connection added/removed List.
bool  RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
  Revert the plug's modification to original status.
void  SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
  Set the plug's status flag.
bool  GetStatusFlag (FBPlugStatusFlag pStatus) const
  Tell if the plug's status has changed.
FBPlug GetOwner ()
  Get the owner of this plug.
FBPlug GetOwned (int pIndex)
  Get the owned plug at specified index.
int  GetOwnedCount ()
  Get the owned plug count.
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.
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.
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.
FBScriptWrapper GetWrapper ()
  Return the wrapper interface of this FBObject.
void  AddWrapper (FBScriptWrapper *)
void  RemoveWrapper (FBScriptWrapper *)
Additional Unique Color ID management.

To support multiple sub items per model/geo selection & picking in easy selection mode using custom rendering routines.

see OpenRealitySDK/Samples/miscellaneous/marker_template for example.

bool  SetAdditionalUniqueColorIDCount (unsigned int pCount)
  Request additional Unique color IDs.
unsigned int  GetAdditionalUniqueColorIDCount () const
  Get additional unique color count.
FBColor  GetAdditionalUniqueColorID (unsigned int pIndex) const
  Get Additional Unique Color Id.
virtual bool  FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
  Store and Retrieve function that can be overloaded.
virtual bool  FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
void  SetupPropertiesForShapes ()
  Setup Shape Properties.
virtual const char *  FbxGetObjectType () override
  Returns the class type inherited by the class of an object, for example: 'Model'.
virtual const char *  FbxGetObjectSubType () override
  Returns the class sub type inherited by the class of an object, for example: 'Default', 'Mesh'.
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.
virtual FBAnimationNode AnimationNodeOutCreate (kReference pUserId, const char *pName, const char *pDataType, bool pIsPublic=false, double *pMin=NULL, double *pMax=NULL, bool pUserData=false)
virtual FBAnimationNode AnimationNodeInGet ()
  Get the (IN/OUT) animation node for this box.
virtual FBAnimationNode AnimationNodeOutGet ()
void *  operator new (size_t stAllocateBlock)
void *  operator new (size_t stAllocateBlock, int blockType, const char *filename, int linenumber)
void  operator delete (void *pvMem)
void  RegisterPropertyEvent (FBPropertyEvent *pPropertyEvent)
void  UnregisterPropertyEvent (FBPropertyEvent *pPropertyEvent)
void  InvalidatePropertyEventsParents ()

Static Public Member Functions

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)
static void  PrintClassDefinitions ()
  Print out internal Class (ID) Definition table.

Public Attributes

FBPropertyCameraStereoType  Stereo
  Read Write Property: //!< This property handles the types of Stereo camera.
FBPropertyAnimatableDouble  InteraxialSeparation
  Read Write Property: This property handles the distance between left and right cameras.
FBPropertyAnimatableDouble  ZeroParallax
  Read Write Property: This property handles the distance on the camera view axis where the zero parallax plane occurs.
FBPropertyAnimatableDouble  ToeInAdjust
  Read Write Property: This property is to offset the computed toe-in effect when it's in Converged mode.
FBPropertyAnimatableDouble  FilmOffsetRightCam
  Read Write Property: This property handles the film offset for the right camera.
FBPropertyAnimatableDouble  FilmOffsetLeftCam
  Read Write Property: This property handles the film offset for the left camera.
FBPropertyCamera  RightCamera
  Read Write Property: This property hold the right camera connected to it.
FBPropertyCamera  LeftCamera
  Read Write Property: This property hold the left camera connected to it.
FBPropertyCamera  CenterCamera
  Read Write Property: This property hold the center camera connected to it.
FBPropertyString  PrecompFileName
  Read Write Property: This property handles the precomp file name.
FBPropertyString  RelativePrecompFileName
  Read Write Property: This property handles the relative precomp file name.
FBPropertyBool  DisplayZeroParallaxPlane
  Read Write Property: Display the zero parallax plane.
FBPropertyDouble  ZeroParallaxPlaneTransparency
  Read Write Property: Zero parallax plane transparency.
FBPropertyColor  ZeroParallaxPlaneColor
  Read Write Property: Zero parallax plane color.
FBPropertyBool  SystemCamera
  Read Only Property: Indicate if this a producer (default or system) camera or a custom (user-created) camera.
FBPropertyCameraFrameSizeMode  FrameSizeMode
  Read Write Property: Frame size standard mode.
FBPropertyCameraResolutionMode  ResolutionMode
  Read Write Property: Resolution standard mode.
FBPropertyDouble  ResolutionWidth
  Read Write Property: Resolution width.
FBPropertyDouble  ResolutionHeight
  Read Write Property: Resolution height.
FBPropertyDouble  WindowWidth
  Read Only Property: Window width.
FBPropertyDouble  WindowHeight
  Read Only Property: Window height.
FBPropertyDouble  PixelAspectRatio
  Read Write Property: Pixel aspect ratio.
FBPropertyDouble  NearPlaneDistance
  Read Write Property: Near plane distance.
FBPropertyDouble  FarPlaneDistance
  Read Write Property: Far plane distance.
FBPropertyBool  MouseLockCamera
  Read Write Property: Mouse lock for camera?
FBPropertyCameraType  Type
  Read Write Property: Type of camera
FBPropertyCameraApertureMode  ApertureMode
  Read Write Property: Aperture mode.
FBPropertyAnimatableDouble  FieldOfView
  Read Write Property: Field of View (used when in horizontal or vertical aperture modes).
FBPropertyAnimatableDouble  FieldOfViewX
  Read Write Property: Field of View X angle (used in horizontal and vertical aperture mode).
FBPropertyAnimatableDouble  FieldOfViewY
  Read Write Property: Field of View Y angle (used in horizontal and vertical aperture mode).
FBPropertyAnimatableDouble  OpticalCenterX
  Read Write Property: Optical Center X (mm).
FBPropertyAnimatableDouble  OpticalCenterY
  Read Write Property: Optical Center Y (mm).
FBPropertyAnimatableDouble  FocalLength
  Read Write Property: Focal Length.
FBPropertyCameraFilmBackType  FilmBackType
  Read Write Property: Film back standard type.
FBPropertyDouble  FilmSizeWidth
  Read Write Property: Width of the film.
FBPropertyDouble  FilmSizeHeight
  Read Write Property: Height of the film.
FBPropertyDouble  FilmAspectRatio
  Read Write Property: Film aspect ratio.
FBPropertyDouble  SqueezeRatio
  Read Write Property: Squeeze ratio.
FBPropertyDouble  OrthoZoom
  Read Write Property: Zoom factor of an orthographic camera.
FBPropertyTexture  BackGroundTexture
  Read Write Property: Background Texture
FBPropertyVideo  BackGroundMedia
FBPropertyCameraViewPlaneMode  ViewBackGroundPlaneMode
  Read Write Property: Background plane view mode
FBPropertyBool  BackGroundImageCenter
  Read Write Property: Center the background image
FBPropertyBool  BackGroundImageFit
  Read Write Property: Fit the background image
FBPropertyBool  BackGroundImageKeepRatio
  Read Write Property: Keep the background image's ratio
FBPropertyBool  BackGroundImageCrop
  Read Write Property: Crop the background image
FBPropertyDouble  BackGroundPlaneDistance
  Read Write Property: Set the distance for the background plane.
FBPropertyCameraDistanceMode  BackGroundPlaneDistanceMode
  Read Write Property: Select mode for the background plane's distance.
FBPropertyAnimatableDouble  ForeGroundAlpha
  Read Write Property: Opacity of foreground.
FBPropertyDouble  ForeGroundMaterialThreshold
  Read Write Property: Material threshold for a transparent foreground.
FBPropertyBool  ForeGroundTransparent
  Read Write Property: Is the foreground transparent?
FBPropertyTexture  ForeGroundTexture
  Read Write Property: ForeGround Texture
FBPropertyVideo  ForeGroundMedia
FBPropertyCameraViewPlaneMode  ViewForeGroundPlaneMode
  Read Write Property: Foreground plane view mode
FBPropertyBool  ForeGroundImageCenter
  Read Write Property: Center the foreground image
FBPropertyBool  ForeGroundImageFit
  Read Write Property: Fit the foreground image
FBPropertyBool  ForeGroundImageKeepRatio
  Read Write Property: Keep the foreground image's ratio?
FBPropertyBool  ForeGroundImageCrop
  Read Write Property: Crop the foreground image
FBPropertyDouble  ForeGroundPlaneDistance
  Read Write Property: Set the distance for the foreground plane.
FBPropertyCameraDistanceMode  ForeGroundPlaneDistanceMode
  Read Write Property: Select mode for the foreground plane's distance.
FBPropertyBool  ViewCameraInterest
  Read Write Property: Show the camera interest?
FBPropertyBool  ViewNearFarPlane
  Read Write Property: Show near/far planes?
FBPropertyBool  ViewShowName
  Read Write Property: Show name?
FBPropertyBool  ViewShowGrid
  Read Write Property: Show grid?
FBPropertyBool  ViewShowAxis
  Read Write Property: Show axis?
FBPropertyBool  ViewShowTimeCode
  Read Write Property: Show time code?
FBPropertyBool  ViewDisplaySafeArea
  Read Write Property: Display safe area?
FBPropertyBool  ViewOpticalCenter
  Read Write Property: View optical center?
FBPropertyCameraSafeAreaMode  SafeAreaMode
  Read Write Property: Select mode for safe area.
FBPropertyAnimatableColor  BackGroundColor
  Read Write Property: Background color for camera.
FBPropertyBool  UseFrameColor
  Read Write Property: Use frame color?
FBPropertyColor  FrameColor
  Read Write Property: Frame color for camera.
FBPropertyBool  UseAntiAliasing
  Read Write Property: Use anti-aliasing?
FBPropertyBool  UseDepthOfField
  Read Write Property: Use depth of field calculations?
FBPropertyBool  InteractiveMode
  Read Write Property: Interactive mode?
FBPropertyDouble  AntiAliasingIntensity
  Read Write Property: Anti-aliasing intensity.
FBPropertyCameraAntiAliasingMethod  AntiAliasingMethod
  Read Write Property: Anti-aliasing method.
FBPropertyInt  NumberOfSamples
  Read Write Property: Number of samples to oversample with.
FBPropertyCameraSamplingType  SamplingType
  Read Write Property: Type of over sampling.
FBPropertyBool  UseAccumulationBuffer
  Read Write Property: Use accumulation buffer?
FBPropertyCameraFocusDistanceSource  FocusDistanceSource
  Read Write Property: Select source for focusing.
FBPropertyDouble  FocusSpecificDistance
  Read Write Property: Specfic distance for focusing.
FBPropertyDouble  FocusAngle
  Read Write Property: Focus Angle (rendering dof).
FBPropertyBool  Use2DMagnifier
  Read Write Property: Enable/Disable the 2D Magnifier.
FBPropertyBool  Display2DMagnifierFrame
  Read Write Property: Enable/Disable the drawing of the 2D Magnifier frame box.
FBPropertyAnimatableDouble  MagnifierZoom
  Read Write Property: 2D Magnifier Zoom value.
FBPropertyAnimatableDouble  MagnifierPosX
  Read Write Property: 2D Magnifier X Position.
FBPropertyAnimatableDouble  MagnifierPosY
  Read Write Property: 2D Magnifier Y Position.
FBPropertyModel  Interest
  Read Write Property: Direct camera's interest.
FBPropertyAnimatableDouble  Roll
  Read Write Property: Camera's roll on it's Z axis.
FBPropertyAnimatableDouble  TurnTable
  Read Write Property: Camera's rotation around its interest.
FBPropertyBool  DisplayTurnTableIcon
  Read Write Property: Enable/Disable the drawing of the Turn Table icon.
FBPropertyAnimatableDouble  MotionBlurIntensity
  Read Write Property: Motion Blur Intensity.
FBPropertyBool  UseMotionBlur
  Read Write Property: Enable Motion Blur.
FBPropertyBool  UseRealTimeMotionBlur
  Read Write Property: Enable Real-time Motion Blur.
FBPropertyInt  CameraViewportX
  Read Only Property: Camera Viewport start position's X value
FBPropertyInt  CameraViewportY
  Read Only Property: Camera Viewport start position's Y value
FBPropertyInt  CameraViewportWidth
  Read Only Property: Camera Viewport width
FBPropertyInt  CameraViewportHeight
  Read Only Property: Camera Viewport height
FBPropertyListHUD  HUDs
  List : HUDs present in this camera
FBPropertyListModel  Children
  List: Children for model.
FBPropertyListShader  Shaders
  List: Shaders for model.
FBPropertyListMaterial  Materials
  List: Materials for model.
FBPropertyListTexture  Textures
  List: Textures with Special UseType (Other than "Color" which should connect to materials).
FBPropertyListDeformer  Deformers
  List: Deformers (Skeleton Deformer or Point Cache Deformer).
FBPropertyBool  Icon3D
  Read Write Property: Is model a 3D icon?
FBPropertyBool  SoftSelected
  Read Write Property: Is model Soft selected?
FBPropertyBool  IsDeformable
  Read Only Property: Is model deformable?
FBPropertyBool  IsConstrained
  Read Only Property: Is model constrained?
FBPropertyBool  SkeletonDeformable
  Read Write Property: Model skeleton deformable.
FBPropertyBool  BlendShapeDeformable
  Read Write Property: Model blend-shape deformable.
FBPropertyBool  ConstrainDeformable
  Read Write Property: Model constraint deformable.
FBPropertyBool  PointCacheDeformable
  Read Write Property: Model point cache deformable.
FBPropertyBool  PointCacheRecord
  Read Write Property: Record Point Cache for model? Not Savable
FBPropertyModel  Parent
  Read Write Property: Parent model.
FBPropertyModel  LookAt
  Read Write Property: Look at model (interest point).
FBPropertyModel  UpVector
  Read Write Property: UpVector model.
FBPropertyGeometry  Geometry
  Read Write Property: Geometry for the model.
FBPropertyInt  GeometryUpdateId
  Read Only Property: model geometry (vertex data) related update id.
FBPropertyMesh  TessellatedMesh
  Read Only Property: Tessellated Mesh for the model.
FBPropertyModelVertexData  ModelVertexData
  Read Only Property: ModelVertexData for the model.
FBPropertyCluster  Cluster
  Read Only Property: Link Cluster for the model.
FBPropertyScene  Scene
  Read Only Property: Scene containing the model.
FBPropertyModelShadingMode  ShadingMode
  Read Write Property: Shading mode for the model.
FBPropertyAnimationNode  AnimationNode
  Read Only Property: Animation node of the model.
FBPropertyModelRotationOrder  RotationOrder
  Read Write Property: Rotation order.
FBPropertyBool  RotationSpaceForLimitOnly
  Read Write Property: Apply Post Rotation Matrix only for Limits?
FBPropertyBool  RotationActive
  Read Write Property: Is model using Rotation Limits?
FBPropertyVector3d  PreRotation
  Read Write Property: Pre Rotation (considered if RotationActive is true)
FBPropertyVector3d  PostRotation
  Read Write Property: Post Rotation (considered if RotationActive is true)
FBPropertyVector3d  RotationMin
  Read Write Property: Min Rotation Limit (considered if RotationActive is true)
FBPropertyVector3d  RotationMax
  Read Write Property: Max Rotation Limit (considered if RotationActive is true)
FBPropertyBool  RotationMinX
  Read Write Property: Is model using Minimum Rotation Limits On X?
FBPropertyBool  RotationMinY
  Read Write Property: Is model using Minimum Rotation Limits On Y?
FBPropertyBool  RotationMinZ
  Read Write Property: Is model using Minimum Rotation Limits On Z?
FBPropertyBool  RotationMaxX
  Read Write Property: Is model using Maximum Rotation Limits On X?
FBPropertyBool  RotationMaxY
  Read Write Property: Is model using Maximum Rotation Limits On Y?
FBPropertyBool  RotationMaxZ
  Read Write Property: Is model using Maximum Rotation Limits On Z?
FBPropertyBool  TranslationActive
  Read Write Property: Is model using Translation Limits?
FBPropertyVector3d  TranslationMin
  Read Write Property: Translation Limit Min.
FBPropertyVector3d  TranslationMax
  Read Write Property: Translation Limit Max.
FBPropertyBool  TranslationMinX
  Read Write Property: Is model using Translation Limits on Min X.
FBPropertyBool  TranslationMinY
  Read Write Property: Is model using Translation Limits on Min Y.
FBPropertyBool  TranslationMinZ
  Read Write Property: Is model using Translation Limits on Min Z.
FBPropertyBool  TranslationMaxX
  Read Write Property: Is model using Translation Limits on Max X.
FBPropertyBool  TranslationMaxY
  Read Write Property: Is model using Translation Limits on Max Y.
FBPropertyBool  TranslationMaxZ
  Read Write Property: Is model using Translation Limits on Max Z.
FBPropertyAnimatableBool  Visibility
  Read Write Property: Visibility of model.
FBPropertyBool  VisibilityInheritance
  Read Write Property: //!< When this value is set to True the Visibility of this model is also applied to all its descendants
FBPropertyAnimatableVector3d  Translation
  Read Write Property: Lcl translation.
FBPropertyAnimatableVector3d  Rotation
  Read Write Property: Lcl rotation.
FBPropertyAnimatableVector3d  Scaling
  Read Write Property: Lcl scaling.
FBPropertyVector3d  GeometricTranslation
  Read Write Property: Geometric translation.
FBPropertyVector3d  GeometricRotation
  Read Write Property: Geometric rotation.
FBPropertyVector3d  GeometricScaling
  Read Write Property: Geometric scaling.
FBPropertyBool  QuaternionInterpolate
  Read Write Property: Use quaternion interpolation.
FBPropertyBool  Show
  Read Write Property: Indicate if the viewer should show the object, according to its visibility value.
FBPropertyBool  Pickable
  Read Write Property: Indicate if a model can be picked in the viewer.
FBPropertyBool  Transformable
  Read Write Property: Indicate if a model can be transformable in the viewer.
FBPropertyColor  UniqueColorId
  Read Only Property: Unique Color Id for color based viewer picking.
FBPropertyBool  PrimaryVisibility
  Read Write Property: Control the geometry render state.
FBPropertyBool  CastsShadows
  Read Write Property: If true, the geometry will produce shadows.
FBPropertyBool  ReceiveShadows
  Read Write Property: If true, the geometry will receive shadows.
const char *  UniqueName
  internal Unique name.
FBPropertyBool  Animatable
  Read Write Property: Is the box animatable.
FBPropertyBool  Live
  Read Write Property: Is live?
FBPropertyBool  RecordMode
  Read Write Property: Is recording?
DataFBComponent *  mLocalPtr
  Handle on DataFBComponent.
FBPropertyManager  PropertyList
  Read Only Property: Manages all of the properties for the component.
FBPropertyListComponent  Components
  List: List of components.
FBPropertyListComponent  Parents
  List: Parents.
FBPropertyBool  Selected
  Read Write Property: Selected property.
FBPropertyString  Name
  Read Write Property: Unique name of object.
FBPropertyString  LongName
  Read Write Property: Name and namespace for object.
FBPropertyFolder  Folder
  Read Write Property: The folder that contain this component.
KObject *  mDummyObject
  Internal Dummy Object for non KObject Components.
bool  mAllocated
  Contain the Allocation State of the Component.

Static Public Attributes

static const double  OrthoFactor
  Constant scale factor to be used with OrthoZoom for orthographic cameras.
static int  TypeInfo
  Contains the Type information of the object.
static const char *  ClassGroupName
  ClassGroupName of the object.

Protected Attributes

FBString  mName
  Name of the component.
HIObject  mObject
  Handle on the Plug.
bool  mSDKComponent
  bool Plug is an SDK component.

Static Protected Attributes

static int  mGlobalTypeInfo
  Represente the Type Index.

Friends

K_DLLIMPORT friend int  __FBRegisterTypeInfo (int pInternalClassId)
  __FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.

Constructor & Destructor Documentation

FBCameraStereo::FBCameraStereo ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

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

Member Function Documentation

K_DEPRECATED_2014 double* FBCamera::GetMatrix ( FBCameraMatrixType  pType ) [inherited]

Obtains the camera's matrix.

Deprecated:
Use FBCamera::GetCameraMatrix() instead
Parameters:
pType Matrix type to obtain.
Returns:
Matrix of doubles (the camera's matrix in question).
void FBModel::GetMatrix ( FBMatrix pMatrix,
FBModelTransformationType  pWhat = kModelTransformation,
bool  pGlobalInfo = true,
FBEvaluateInfo pEvaluateInfo = NULL 
) [inherited]

Get a matrix from the model.

Parameters:
pWhat Type of information requested (default=transformation).
pGlobalInfo true if it is GlobalInfo, false if Local (default=true).
Return values:
pMatrix Matrix to fill with requested information.
Parameters:
pEvaluateInfo EvaluateInfo, Take Display if none specified.
void FBCamera::GetCameraMatrix ( FBMatrix pMatrix,
FBCameraMatrixType  pType,
FBEvaluateInfo pEvalInfo = NULL 
) [inherited]

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.
FBVector4d FBCamera::InverseProjection ( int  pX,
int  pY,
double  pDistanceFromCamera,
bool  pRelativeToViewport = false 
) [inherited]

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
virtual void FBModel::FBDelete ( ) [virtual, inherited]

Open Reality deletion function.

Reimplemented from FBComponent.

FBModel::IQuery_Declare ( K_IMPLEMENTATION  ) [inherited]
FBModel::ICallback_Declare ( K_IMPLEMENTATION  ) [inherited]

Interface to ICallback.

Reimplemented from FBComponent.

virtual FBModel* FBModel::Clone ( ) [virtual, inherited]

Clone the model.

This will duplicate the current model.

Returns:
Newly created model.
void FBModel::SetMatrix ( FBMatrix  pMatrix,
FBModelTransformationType  pWhat = kModelTransformation,
bool  pGlobalInfo = true,
bool  pPushUndo = false,
FBEvaluateInfo pEvaluateInfo = NULL 
) [inherited]

Set a matrix for the model.

Parameters:
pMatrix Information to use to set the model's matrix.
pWhat Type of matrix to set (default=transformation).
pGlobalInfo true if it is GlobalInfo, false if Local (default=true).
pPushUndo true if this operation is undoable, don't push undo in non UI thread.
pEvaluateInfo EvaluateInfo, Take Display if none specified
void FBModel::SetVector ( FBVector3d  pVector,
FBModelTransformationType  pWhat = kModelTranslation,
bool  pGlobalInfo = true,
bool  pPushUndo = false,
FBEvaluateInfo pEvaluateInfo = NULL 
) [inherited]

Set a vector for the model.

Parameters:
pVector Vector to use to set values.
pWhat Type of information to set (default=translation, inverses not supported).
pGlobalInfo true if it is GlobalInfo, false if Local (default=true).
pPushUndo true if this operation is undoable, don't push undo in non UI thread.
pEvaluateInfo EvaluateInfo, Take Display if none specified
void FBModel::GetVector ( FBVector3d pVector,
FBModelTransformationType  pWhat = kModelTranslation,
bool  pGlobalInfo = true,
FBEvaluateInfo pEvaluateInfo = NULL 
) [inherited]

Get a vector from the model.

Parameters:
pWhat Type of information requested (default=translation, inverses not supported).
pGlobalInfo true if it is GlobalInfo, false if Local (default=true).
pEvaluateInfo EvaluateInfo, Take Display if none specified
Return values:
pVector Vector to fill with requested values.
bool FBModel::IsEvaluationReady ( FBModelEvaluationTaskType  pWhat,
FBEvaluateInfo pEvaluateInfo = NULL 
) const [inherited]

Is the model's evaluation task result ready.

Parameters:
pWhat Type of evaluation task.
pEvaluateInfo EvaluateInfo, Take Display if none specified
Return values:
\b true if the evaluation task result is ready in place.
void FBModel::MatrixToRotation ( FBRVector pRotation,
const FBMatrix pMatrix 
) [inherited]

Convert Rotation Matrix to Euler Vector based on model's rotation order.

Parameters:
pMatrix Matrix to convert
Return values:
pRotation Resulting euler vector.
void FBModel::RotationToMatrix ( FBMatrix pMatrix,
const FBRVector pRotation 
) [inherited]

Convert Euler Vector to Rotation Matrix based on model's rotation order.

Parameters:
pRotation Object space rotation vector to convert
Return values:
pMatrix Resulting rotation matrix.
void FBModel::LRMToDof ( FBRVector pDof,
const FBMatrix pLM 
) [inherited]

Convert local matrix to object space vector.

Parameters:
pLM Local rotation matrix to convert
Return values:
pDof Resulting object space vector.
Note:
Use this function when you want to convert local rotation to euler with proper pre/post transformation and rotation order applied from this model.
void FBModel::DofToLRM ( FBMatrix pLM,
const FBRVector pDof 
) [inherited]

Convert object space vector to local matrix.

Parameters:
pDof Vector to convert
Return values:
pLM Resulting local rotation matrix.
Note:
Use this function when you want to convert euler to local rotation with proper pre/post transformation and rotation order applied from this model.
void FBModel::SetSchematicPosition ( int  pX,
int  pY 
) [inherited]

Set the position in the schematic view for the model.

Parameters:
pX X position to set.
pY Y position to set.
void FBModel::SetSchematicPosition ( FBVector2d  pVector2d ) [inherited]

Set the position in the schematic view for the model.

Parameters:
pVector2d Position to set.
FBVector2d FBModel::GetSchematicPosition ( ) [inherited]

Get the position in the schematic view for the model.

Returns:
Current position for the model.
void FBModel::GetBoundingBox ( FBVector3d pMin,
FBVector3d pMax 
) [inherited]

Get the bounding box of the model.

Note. for deformable model, this function will provide the approximated (larger than the smallest) bounding box for performance consideration.

Return values:
pMin Minimum value of the bounding box.
pMax Maximum value of the bounding box.
bool FBModel::IsVisible ( FBEvaluateInfo pEvaluateInfo = NULL ) [inherited]

If the model is visible.

Note. this query will consider self Visibility property, plus parent node/set Visibility. The visibility of a model is affected by 4 parameters: 1. The model's own visibility 2. The model's parent's visibility (if any) 3. The visibility of the set to which model belongs (if any) 4. VisibilityInheritance of the model

Parameters:
pEvaluateInfo evaluate info,
Returns:
true if visible for the given evaluate info.
FBModelCullingMode FBModel::GetCullingMode ( ) const [inherited]

Get Model Culling Mode.

Returns:
Model Culling Mode.
void FBModel::SetCullingMode ( FBModelCullingMode  pCullingMode ) [inherited]

Set Model Cullin Mode.

Parameters:
pCullingMode Culling Mode to be set.
void FBModel::ForceAlwaysEvaluate ( ) [inherited]

Force Always Evaluate.

In some case, MoBu kernel perform optimization by skipping certain evaluation tasks. This function stop skipping for this model.

bool FBModel::IsForceAlwaysEvaluate ( ) [inherited]

Return Force Always Evaluate status.

int FBModel::NoFrustumCullingRequire ( ) [inherited]

Acquire no frustum culling request.

Returns:
Current no frustum culling request count after function call.
int FBModel::NoFrustumCullingRelease ( ) [inherited]

Release no frustum culling request.

Returns:
Current no frustum culling request count after function call.
bool FBModel::UseFrustumCulling ( ) [inherited]

Get the current Frustum Culling Status.

Returns:
True if model don't use frustum culling currently.
virtual bool FBModel::HasCustomDisplay ( ) [inline, virtual, inherited]

Function to overload to handle custom display.

Returns:
True is this model class has custom display function ModelDisplay

Definition at line 506 of file fbmodel.h.

{ return false; }
virtual void FBModel::CustomModelDisplay ( FBCamera pCamera,
FBModelShadingMode  pShadingMode,
FBModelRenderPass  pRenderPass,
float  pPickingAreaWidth,
float  pPickingAreaHeight 
) [inline, virtual, inherited]

Custom display function, called when HasCustomDisplay returns true;.

Parameters:
pCamera Current camera for display.
pShadingMode Shading mode to render see FBModelShadingMode.
pRenderPass Actual rendering pass, see FBModelRenderPass.
pPickingAreaWidth Width of picking area.
pPickingAreaHeight Height of picking area.

Definition at line 515 of file fbmodel.h.

{}
virtual bool FBModel::CustomModelPicking ( int  pNbHits,
unsigned int *  pSelectBuffer,
FBCamera pCamera,
int  pMouseX,
int  pMouseY,
FBTVector pLocalRaySrc,
FBTVector pLocalRayDir,
FBTVector pWorldRaySrc,
FBTVector pWorldRayDir,
FBMatrix pGlobalInverseMatrix,
FBTVector pOutPickedPoint 
) [inline, virtual, inherited]

Custom picking for selection, called when HasCustomDisplay returns true;.

Parameters:
pNbHits Number of hits.
pSelectBuffer OpenGL hit buffer.
pCamera Current camera for rendering.
pMouseX Mouse X position.
pMouseY Mouse Y position.
pLocalRaySrc Local picking ray source.
pLocalRayDir Local picking ray direction.
pWorldRaySrc World coordinate picking ray source.
pWorldRayDir World coordinate picking ray direction.
pGlobalInverseMatrix Inverse transformation matrix of the model.
pOutPickedPoint Picked position.

Definition at line 530 of file fbmodel.h.

                                           { return false; }
virtual bool FBModel::ClosestRayIntersection ( const FBTVector pRayOrigin,
const FBTVector pRayEnd,
FBTVector pIntersectPos,
FBNormal pIntersectNormal 
) [virtual, inherited]

Determines the first intersection point's position and normal between ray and model surface.

Remarks:
All coordinates specified in local model space, override this function in subclass if custom intersection method is desired. See /OpenReality/Samples/miscellaneous/ormodel_template ORSDK sample project for example.
Parameters:
pRayOrigin Specifies origin of the view ray.
pRayEnd Specifies end of the view ray.
pIntersectPos return the first intersection point's position;
pIntersectNormal return the first intersection point's normal;
Returns:
Returns true if at least one intersects with ray, and false if otherwise.
unsigned char* FBModel::GetSelectedPoints ( ) [inherited]

Get the list of the points selection state.

Returns:
Pointer to the list of the points selection state.
int FBModel::GetSelectedPointsCount ( ) [inherited]

Get the number of selected points in the model.

Returns:
Number of selected points.
bool FBModel::SetAdditionalUniqueColorIDCount ( unsigned int  pCount ) [inherited]

Request additional Unique color IDs.

Parameters:
pCount User should note that Unique Color ID resource is limited (only 24 bits), hence should avoid to use unnecessary large number.
Returns:
True if Unique ColorId resource is available.
unsigned int FBModel::GetAdditionalUniqueColorIDCount ( ) const [inherited]

Get additional unique color count.

Returns:
Additional Unique Color Count.
FBColor FBModel::GetAdditionalUniqueColorID ( unsigned int  pIndex ) const [inherited]

Get Additional Unique Color Id.

Parameters:
pIndex the requested unique color id index, can't be larger than GetAdditionalColorIDCount()
Returns:
Additional Unique ColorId.
virtual bool FBModel::FbxStore ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
) [virtual, inherited]

Store and Retrieve function that can be overloaded.

Parameters:
pFbxObject FBX Object that is used to communicate I/O operations.
pStoreWhat Which attributes are currently stored/retrieved.

Reimplemented from FBBox.

Reimplemented in FBModelNull, and FBModelMarker.

virtual bool FBModel::FbxRetrieve ( FBFbxObject pFbxObject,
kFbxObjectStore  pStoreWhat 
) [virtual, inherited]

Reimplemented from FBBox.

Reimplemented in FBModelNull, and FBModelMarker.

void FBModel::SetupPropertiesForShapes ( ) [inherited]

Setup Shape Properties.

Normally this function is called automatically at the next global synchronization point after the geometry has been updated. However you must call it explicitly to access the shape properties immediately after shapes adding/removing before next global synchronization point.

virtual const char* FBModel::FbxGetObjectType ( ) [override, virtual, inherited]

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

Reimplemented from FBBox.

Reimplemented in FBModelNull, and FBModelMarker.

virtual const char* FBModel::FbxGetObjectSubType ( ) [override, virtual, inherited]

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

Reimplemented from FBBox.

Reimplemented in FBModelNull, and FBModelMarker.

virtual FBAnimationNode* FBBox::AnimationNodeInCreate ( kReference  pUserId,
const char *  pName,
const char *  pDataType,
bool  pIsPublic = false,
double *  pMin = NULL,
double *  pMax = NULL,
bool  pUserData = false 
) [virtual, inherited]

Creation of IN/OUT Animation Nodes.

Parameters:
pUserId User-defined reference number.
pName Name of animation node.
pDataType Type of data being animated.
pIsPublic Determine if the animation node is published, that means whether to show it in property editor and have input / output in relation constraints editor (default is false).
pMin Minimum values for data (default is NULL).
pMax Maximum values for data (default is NULL).
pUserData Is this user data? False means the property is NOT animated, user cannot change the data. Especially for device, it doesn't make sense to make it animated, unless you want to record the device data. (default is false).
Returns:
A handle to the newly created animation node.

Reimplemented in FBDevice.

virtual FBAnimationNode* FBBox::AnimationNodeOutCreate ( kReference  pUserId,
const char *  pName,
const char *  pDataType,
bool  pIsPublic = false,
double *  pMin = NULL,
double *  pMax = NULL,
bool  pUserData = false 
) [virtual, inherited]
virtual bool FBBox::EvaluateAnimationNodes ( FBEvaluateInfo pEvaluateInfo ) [virtual, inherited]

Evaluation of non TRS nodes that needs to be evaluated.

This function is called by the real-time engine in order to process animation information.

Parameters:
pEvaluateInfo Information concerning the evaluation of the animation (time, etc.)
Returns:
true if animation node notification is successful.
virtual bool FBBox::AnimationNodeNotify ( FBAnimationNode pAnimationNode,
FBEvaluateInfo pEvaluateInfo 
) [virtual, inherited]

Notification function for animation thread.

This function is called by the real-time engine in order to process animation information.

Parameters:
pAnimationNode Node containing the modified information.
pEvaluateInfo Information concerning the evaluation of the animation (time, etc.)
Returns:
true if animation node notification is successful.

Reimplemented in FBDevice, FBDeviceOptical, and FBDeviceSync.

virtual bool FBBox::AnimationNodeDestroy ( FBAnimationNode pAnimationNode ) [virtual, inherited]

Destroy an animation node.

Parameters:
pAnimationNode Handle to the animation node to be destroyed.
Returns:
true if destruction was successful.
virtual bool FBBox::AnimationNodeIsUserData ( FBAnimationNode pAnimationNode ) [virtual, inherited]

Is the animation node user data?

Parameters:
pAnimationNode Handle to the animation to be queried.
Returns:
true if node is user data.
virtual void FBBox::AnimationNodesOutDisableIfNotWritten ( FBEvaluateInfo pEvaluateInfo ) [virtual, inherited]

This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo.

Parameters:
pEvaluateInfo Evaluation synchronization object (contains evaluation id).
Note:
This can be also done per individual AnimationNode -> FBAnimationNode::DisableIfNotWritten
virtual FBAnimationNode* FBBox::AnimationNodeInGet ( ) [virtual, inherited]

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

Returns:
A handle to the animation node for this box.
virtual FBAnimationNode* FBBox::AnimationNodeOutGet ( ) [virtual, inherited]
FBBox::IObject_Declare ( K_IMPLEMENTATION  ) [inherited]
FBComponent::GetInternalClassId ( ) [static, inherited]
Returns:
Internal class Id

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

virtual bool FBComponent::FBCreate ( ) [virtual, inherited]
virtual void FBComponent::FBDestroy ( ) [virtual, inherited]
virtual bool FBComponent::SetHIObject ( HIObject  pObject,
bool  pSDKComponent 
) [override, virtual, inherited]

Assign component to an internal pointer.

Reimplemented from FBPlug.

virtual int FBComponent::PropertyAdd ( FBProperty pProperty ) [virtual, inherited]

Add a property to the component's property manager.

Parameters:
pProperty The property to add to the property manager.
Returns:
Index in the property array where property was inserted.
bool FBComponent::PropertyAddReferenceProperty ( FBProperty pReferenceProperty ) [inherited]

Add a reference property to the component's property manager.

Parameters:
pReferenceProperty The property to from an other object to add a reference to (property cannot be a custom ORSDK property).
Returns:
True if the reference property could be added.
void FBComponent::PropertyRemove ( FBProperty pProperty ) [inherited]

Remove a Property from the component's Property manager.

If the property was dynamically allocated, it is deleted.

Parameters:
pProperty The property to remove from the property manager.
void FBComponent::PropertyGetModifiedList ( FBArrayTemplate< FBProperty * > &  pPropList,
FBPlugModificationFlag  pModificationFlags 
) [inherited]

Get list of properties which have been modified since last loading.

Parameters:
pPropList property list to hold the modified properties.
pModificationFlags type of modification to query.
FBProperty* FBComponent::PropertyCreate ( const char *  pName,
FBPropertyType  pType,
const char *  pDataType,
bool  pAnimatable,
bool  pIsUser = false,
FBProperty pReferenceSource = NULL 
) [inherited]

Create user or dynamic property.

Parameters:
pName The name of the property.
pType Type of the property. See enum FBPropertyType.
pDataType DataType of the property.
pAnimatable To specify if the property can be animated.
pIsUser To specify if the property is available as a custom property or dynamic and attached to the object.
pReferenceSource Specifies the property that a reference refers to.
FBObjectFlag FBComponent::GetObjectFlags ( ) [inherited]

Get all Object Flags (concatenated).

Returns:
Get all object flags in one call. Flags can be concatenated.
void FBComponent::SetObjectFlags ( FBObjectFlag  pFlags ) [inherited]

SetObjectFlags.

Parameters:
pFlags Set flag values. Note: this function overwrites all flags with those passed in parameter.
bool FBComponent::HasObjectFlags ( FBObjectFlag  pFlags ) [inherited]

Check whether a specific object flag is enabled.

Parameters:
pFlags Flags to check if they are present.
Returns:
True if all flags in pFlags are enabled.
void FBComponent::EnableObjectFlags ( FBObjectFlag  pFlags ) [inherited]

Enable a specific Object Flags.

Parameters:
pFlags Flags to enable.
void FBComponent::DisableObjectFlags ( FBObjectFlag  pFlags ) [inherited]

Disable a specific Object Flags.

Parameters:
pFlags Flags to disable.
void FBComponent::SetObjectStatus ( FBObjectStatus  pStatus,
bool  pValue 
) [inherited]

Enable/Disable a specific Object Status.

Parameters:
pStatus Status to change.
pValue Value to change the status to.
bool FBComponent::GetObjectStatus ( FBObjectStatus  pStatus ) [inherited]

Check to see if an object status is enabled.

Parameters:
pStatus Status to query.
bool FBComponent::ProcessNamespaceHierarchy ( FBNamespaceAction  pNamespaceAction,
const char *  pNamespaceName,
const char *  pReplaceTo = NULL,
bool  pAddRight = true 
) [inherited]

ProcessNamespaceHierarchy.

New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This recursive function goes through the whole hierarchy (children) to add/replace the prefix. If you need to work on a single object, use the ProcessObjectPrefix function.

Parameters:
pNamespaceAction Which operation to do on the hierarchy (children).
pNamespaceName The Namespace name on Add/Delete or the prefix to replace in case of replace.
pReplaceTo The new Namespace Name or NULL in case of add or delete.
pAddRight Whether to add the namespace on right-most or left-most side or other namespace.
Returns:
return true if process successful.
bool FBComponent::ProcessObjectNamespace ( FBNamespaceAction  pNamespaceAction,
const char *  pNamespaceName,
const char *  pReplaceTo = NULL,
bool  pAddRight = true 
) [inherited]

ProcessObjectNamespace.

New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This function is the same as ProcessNamespaceHierarchy except that it applies only on the current object and not to the object's children.

Parameters:
pNamespaceAction Which operation to do on the hierarchy (children).
pNamespaceName The Namespace name on Add/Delete or the prefix to replace in case of replace.
pReplaceTo The new Namespace Name or NULL in case of add or delete.
pAddRight Whether to add the namespace on right-most or left-most side or other namespace.
Returns:
return true if process successful.
virtual const char* FBComponent::ClassName ( ) [override, virtual, inherited]

Get the class name.

Returns:
The class name (i.e. "FBComponent").

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

virtual bool FBComponent::UseCustomPropertyViewSet ( ) const [inline, virtual, inherited]

Use the custom property viewSet or not.

To have custom property view for custom subclass, modification bin/config/propertyview.fbx is required.

Returns:
False if to use internal corresponding object's viewSet of the parent class.

Definition at line 791 of file fbcomponent.h.

{ return true; }
const char* FBComponent::GetFullName ( void  ) [inherited]

Get the full name.

Returns:
the full name of the component.
void FBComponent::SetOwnerNamespace ( FBNamespace pOwnerNSObj ) [inherited]

Set the owner Namespace object.

FBNamespace* FBComponent::GetOwnerNamespace ( void  ) [inherited]

Get the owner Namespace object.

Returns:
the owner Namespace object
FBFileReference* FBComponent::GetOwnerFileReference ( void  ) [inherited]

Get the owner FileReference object.

Returns:
the owner FileReference object
void FBComponent::HardSelect ( ) [inherited]

HardSelect.

Selects the object, and emits a hard select event for UI update notification.

void* FBComponent::operator new ( size_t  stAllocateBlock ) [inherited]
void* FBComponent::operator new ( size_t  stAllocateBlock,
int  blockType,
const char *  filename,
int  linenumber 
) [inherited]
void FBComponent::operator delete ( void *  pvMem ) [inherited]
void FBComponent::RegisterPropertyEvent ( FBPropertyEvent pPropertyEvent ) [inherited]
void FBComponent::UnregisterPropertyEvent ( FBPropertyEvent pPropertyEvent ) [inherited]
void FBComponent::InvalidatePropertyEventsParents ( ) [inherited]
virtual bool FBComponent::Is ( int  pTypeId ) [virtual, inherited]

Returns true if object is of type TypeId.

Parameters:
pTypeId TypeId to compare object to.
Returns:
Result of the comparison.

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

virtual int FBComponent::GetTypeId ( ) [virtual, inherited]

GetTypeId( int pTypeId )

Returns:
The TypeInfo of the object

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

static void FBComponent::FBComponentSetName ( FBComponent pObject,
const char *  pName 
) [static, inherited]
static const char* FBComponent::FBComponentGetName ( FBComponent pObject ) [static, inherited]
static void FBComponent::FBComponentSetLongName ( FBComponent pObject,
const char *  pName 
) [static, inherited]
static const char* FBComponent::FBComponentGetLongName ( FBComponent pObject ) [static, inherited]
void FBComponent::KObjectEvent ( HIRegister  pView,
HKEventBase  pEvent 
) [inherited]
virtual HIObject FBPlug::GetHIObject ( ) const [virtual, inherited]

Return an internal pointer.

bool FBPlug::IsSDKComponent ( ) [inherited]

Return whether or not item is an SDK component.

bool FBPlug::ConnectSrc ( FBPlug pSrc,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a source connection.

Parameters:
pSrc Source plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ConnectDst ( FBPlug pDst,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a destination connection.

Parameters:
pDst Destination plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False)
bool FBPlug::ConnectSrcAt ( int  pDst_SrcIndex,
FBPlug pSrc,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a source connection.

Parameters:
pDst_SrcIndex Index that tells where to add this source connection in the destination's connection list. if index is out of bound, and this source connection will be appended at the end.
pSrc Source plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ConnectDstAt ( int  pSrc_DstIndex,
FBPlug pDst,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

Add a destination connection.

Parameters:
pSrc_DstIndex Index that tells where to add this destination connection in the source's connection list. if index is out of bound, and this destination connection will be appended at the end.
pDst Destination plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectDst ( FBPlug pDst ) [inherited]

Remove a destination connection.

Parameters:
pDst Destination plug.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectSrc ( FBPlug pSrc ) [inherited]

Remove a source connection.

Parameters:
pSrc Source plug.
Returns:
A boolean indicating success (True) or failure (False).
void FBPlug::DisconnectAllSrc ( ) [inherited]

Remove all source connections.

void FBPlug::DisconnectAllDst ( ) [inherited]

Remove all destination connections.

bool FBPlug::DisconnectDstAt ( int  pIndex ) [inherited]

Remove a destination connection at a specified index.

Parameters:
pIndex Destination plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectSrcAt ( int  pIndex ) [inherited]

Remove a source connection at a specified index.

Parameters:
pIndex Source plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ReplaceDstAt ( int  pIndex,
FBPlug pDst 
) [inherited]

Replace a destination connection at a specified index.

Parameters:
pIndex Destination plug index.
pDst Plug that will replace the other at index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ReplaceSrcAt ( int  pIndex,
FBPlug pSrc 
) [inherited]

Replace a source connection at a specified index.

Parameters:
pIndex Source plug index.
pSrc Plug that will replace the other at index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::SwapSrc ( int  pIndexA,
int  pIndexB 
) [inherited]

Swap source connection at index A with source connection at index B.

Parameters:
pIndexA Plug index.
pIndexB Other plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::MoveSrcAt ( int  pIndex,
int  pAtIndex 
) [inherited]

Move source connection at pIndex to pAtIndex.

Parameters:
pIndex Plug current index.
pAtIndex Plug new index.
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This is not like the swap function since the connection at pAtIndex is untouched.
bool FBPlug::MoveSrcAt ( FBPlug pSrc,
FBPlug pAtSrc 
) [inherited]

Move source connection pSrc to the position of pAtSrc.

Parameters:
pSrc Plug.
pAtSrc Plug that mark where we want to insert (will insert before this one).
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This is not like the swap function since the connection at pAtSrc is untouched.
int FBPlug::GetSrcCount ( ) [inherited]

Get source connection count.

Returns:
Total sources connections count.
FBPlug* FBPlug::GetSrc ( int  pIndex ) [inherited]

Get a source connection's plug at specified index.

Parameters:
pIndex Index of the source connection's plug.
Returns:
Source plug at specified index.
FBConnectionType FBPlug::GetSrcType ( int  pIndex ) [inherited]

Get a source connection's type at specified index.

Parameters:
pIndex Index of the source connection's type.
Returns:
Source connection's type at specified index.
int FBPlug::GetDstCount ( ) [inherited]

Get destination connection count.

Returns:
Total destinations connections count.
FBPlug* FBPlug::GetDst ( int  pIndex ) [inherited]

Get a destination connection's plug at specified index.

Parameters:
pIndex Index of the destination connection's plug.
Returns:
Destination plug at specified index.
FBConnectionType FBPlug::GetDstType ( int  pIndex ) [inherited]

Get a destination connection's type at specified index.

Parameters:
pIndex Index of the destination connection's type.
Returns:
Destination connection's type at specified index.
bool FBPlug::BeginChange ( ) [inherited]

Begins a change on multiple plugs.

Returns:
A boolean indicating success (True) or failure (False).
void FBPlug::EndChange ( ) [inherited]

Ends a change on multiple plugs.

void FBPlug::SetSelfModified ( FBPlugModificationFlag  pFlag,
bool  pBool 
) [inherited]

Set the plug's self modification flag.

Parameters:
pFlag bitwise AND of self modification flags.
pBool true if self changed.
bool FBPlug::GetSelfModified ( FBPlugModificationFlag  pFlag ) [inherited]

Tell if the plug's self has changed.

Parameters:
pFlag bitwise AND of self modification flags.
Returns:
true if self changed
void FBPlug::SetContentModified ( FBPlugModificationFlag  pFlag,
bool  pBool 
) [inherited]

Set the plug's owned property/object's modification flag.

Parameters:
pFlag bitwise AND of content modification flags.
pBool true if content has modification.
bool FBPlug::GetContentModified ( FBPlugModificationFlag  pFlag ) [inherited]

Tell if the plug's content has changed.

Parameters:
pFlag bitwise AND of content modification flags.
Returns:
true if content connection changed.
int FBPlug::GetPlugConnectionModifiedList ( FBPlugList pPlugList,
FBPlugModificationFlag  pConnectionModificatonFlag,
bool  pAddRemove 
) [inherited]

Get plug's modified src/dst property/object connection added/removed List.

Parameters:
pPlugList plug list to fill up.
pConnectionModificatonFlag Src/Dst Property/Object connection modification flag.
pAddRemove Ask for the added list if true, removed list if false.
Returns:
count of list;
bool FBPlug::RevertModification ( FBPlugModificationFlag  pFlag = kFBAllModifiedMask ) [inherited]

Revert the plug's modification to original status.

Parameters:
pFlag the type of modification to be reverted.
Returns:
true if revert successfully.
void FBPlug::SetStatusFlag ( FBPlugStatusFlag  pStatus,
bool  pValue 
) [inherited]

Set the plug's status flag.

Parameters:
pStatus bitwise AND of status flags.
pValue true if status has modification.
bool FBPlug::GetStatusFlag ( FBPlugStatusFlag  pStatus ) const [inherited]

Tell if the plug's status has changed.

Parameters:
pStatus bitwise AND of self modification flags.
Returns:
true if self changed
FBPlug* FBPlug::GetOwner ( ) [inherited]

Get the owner of this plug.

Very useful for properties since they are plugs too.

Returns:
The owner of this plug.
FBPlug* FBPlug::GetOwned ( int  pIndex ) [inherited]

Get the owned plug at specified index.

Parameters:
pIndex Index of the owned plug to get.
Returns:
The owned plug at specified index.
int FBPlug::GetOwnedCount ( ) [inherited]

Get the owned plug count.

Returns:
The owned plug count.
virtual bool FBPlug::PlugDataNotify ( FBConnectionAction  pAction,
FBPlug pThis,
void *  pData = NULL,
void *  pDataOld = NULL,
int  pDataSize = 0 
) [virtual, inherited]

PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pData Current data, meaning depends of plug action.
pDataOld Previous data, meaning depends of plug action.
pDataSize Size of data.
Returns:
unused should return true
virtual bool FBPlug::PlugStateNotify ( FBConnectionAction  pAction,
FBPlug pThis,
void *  pData = NULL,
void *  pDataOld = NULL,
int  pDataSize = 0 
) [virtual, inherited]

PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pData Current data, meaning depends of plug action.
pDataOld Previous data, meaning depends of plug action.
pDataSize Size of data.
Returns:
unused should return true except in the case of property rename kFBRename
virtual bool FBPlug::PlugNotify ( FBConnectionAction  pAction,
FBPlug pThis,
int  pIndex,
FBPlug pPlug = NULL,
FBConnectionType  pConnectionType = kFBConnectionTypeNone,
FBPlug pNewPlug = NULL 
) [virtual, inherited]

PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pIndex Index of the plug.
pPlug Other plug concerned.
pConnectionType Connection type between the plugs.
pNewPlug New plug (for the replace event).
Returns:
should by default return true except in the case of connection requests (kFBRequestConnectSrc or kFBRequestConnectDst)
static void FBPlug::PrintClassDefinitions ( ) [static, inherited]

Print out internal Class (ID) Definition table.

For internal debug purpose only.

FBScriptWrapper* FBWrapperHolder::GetWrapper ( ) [inherited]

Return the wrapper interface of this FBObject.

void FBWrapperHolder::AddWrapper ( FBScriptWrapper ) [inherited]
void FBWrapperHolder::RemoveWrapper ( FBScriptWrapper ) [inherited]

Friends And Related Function Documentation

K_DLLIMPORT friend int __FBRegisterTypeInfo ( int  pInternalClassId ) [friend, inherited]

__FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.


Member Data Documentation

FBPropertyCameraStereoType FBCameraStereo::Stereo

Read Write Property: //!< This property handles the types of Stereo camera.

Definition at line 413 of file fbcamera.h.

Read Write Property: This property handles the distance between left and right cameras.

Definition at line 414 of file fbcamera.h.

Read Write Property: This property handles the distance on the camera view axis where the zero parallax plane occurs.

Definition at line 415 of file fbcamera.h.

Read Write Property: This property is to offset the computed toe-in effect when it's in Converged mode.

Definition at line 416 of file fbcamera.h.

Read Write Property: This property handles the film offset for the right camera.

(inch)

Definition at line 417 of file fbcamera.h.

Read Write Property: This property handles the film offset for the left camera.

(inch)

Definition at line 418 of file fbcamera.h.

FBPropertyCamera FBCameraStereo::RightCamera

Read Write Property: This property hold the right camera connected to it.

Definition at line 420 of file fbcamera.h.

FBPropertyCamera FBCameraStereo::LeftCamera

Read Write Property: This property hold the left camera connected to it.

Definition at line 421 of file fbcamera.h.

FBPropertyCamera FBCameraStereo::CenterCamera

Read Write Property: This property hold the center camera connected to it.

Must be either the master, left or right camera.

Definition at line 422 of file fbcamera.h.

Read Write Property: This property handles the precomp file name.

Definition at line 424 of file fbcamera.h.

Read Write Property: This property handles the relative precomp file name.

Definition at line 425 of file fbcamera.h.

Read Write Property: Display the zero parallax plane.

Definition at line 427 of file fbcamera.h.

Read Write Property: Zero parallax plane transparency.

Definition at line 428 of file fbcamera.h.

Read Write Property: Zero parallax plane color.

Definition at line 429 of file fbcamera.h.

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

Definition at line 214 of file fbcamera.h.

FBPropertyCameraFrameSizeMode FBCamera::FrameSizeMode [inherited]

Read Write Property: Frame size standard mode.

Definition at line 217 of file fbcamera.h.

FBPropertyCameraResolutionMode FBCamera::ResolutionMode [inherited]

Read Write Property: Resolution standard mode.

Definition at line 218 of file fbcamera.h.

Read Write Property: Resolution width.

Definition at line 219 of file fbcamera.h.

Read Write Property: Resolution height.

Definition at line 220 of file fbcamera.h.

Read Only Property: Window width.

Definition at line 221 of file fbcamera.h.

Read Only Property: Window height.

Definition at line 222 of file fbcamera.h.

Read Write Property: Pixel aspect ratio.

Definition at line 223 of file fbcamera.h.

Read Write Property: Near plane distance.

Definition at line 224 of file fbcamera.h.

Read Write Property: Far plane distance.

Definition at line 225 of file fbcamera.h.

Read Write Property: Mouse lock for camera?

Definition at line 226 of file fbcamera.h.

FBPropertyCameraType FBCamera::Type [inherited]

Read Write Property: Type of camera

Definition at line 227 of file fbcamera.h.

FBPropertyCameraApertureMode FBCamera::ApertureMode [inherited]

Read Write Property: Aperture mode.

Definition at line 228 of file fbcamera.h.

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

Definition at line 229 of file fbcamera.h.

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

Definition at line 231 of file fbcamera.h.

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

Definition at line 232 of file fbcamera.h.

Read Write Property: Optical Center X (mm).

Definition at line 233 of file fbcamera.h.

Read Write Property: Optical Center Y (mm).

Definition at line 234 of file fbcamera.h.

Read Write Property: Focal Length.

Definition at line 235 of file fbcamera.h.

FBPropertyCameraFilmBackType FBCamera::FilmBackType [inherited]

Read Write Property: Film back standard type.

Definition at line 237 of file fbcamera.h.

Read Write Property: Width of the film.

Definition at line 238 of file fbcamera.h.

Read Write Property: Height of the film.

Definition at line 239 of file fbcamera.h.

Read Write Property: Film aspect ratio.

Definition at line 240 of file fbcamera.h.

Read Write Property: Squeeze ratio.

Definition at line 241 of file fbcamera.h.

const double FBCamera::OrthoFactor [static, inherited]

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

Definition at line 243 of file fbcamera.h.

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 273 of file fbcamera.h.

FBPropertyTexture FBCamera::BackGroundTexture [inherited]

Read Write Property: Background Texture

Definition at line 277 of file fbcamera.h.

FBPropertyVideo FBCamera::BackGroundMedia [inherited]
Deprecated:
Read Write Property: BackGround Image

Definition at line 278 of file fbcamera.h.

FBPropertyCameraViewPlaneMode FBCamera::ViewBackGroundPlaneMode [inherited]

Read Write Property: Background plane view mode

Definition at line 279 of file fbcamera.h.

Read Write Property: Center the background image

Definition at line 280 of file fbcamera.h.

Read Write Property: Fit the background image

Definition at line 281 of file fbcamera.h.

Read Write Property: Keep the background image's ratio

Definition at line 282 of file fbcamera.h.

Read Write Property: Crop the background image

Definition at line 283 of file fbcamera.h.

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

Definition at line 284 of file fbcamera.h.

FBPropertyCameraDistanceMode FBCamera::BackGroundPlaneDistanceMode [inherited]

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

Definition at line 285 of file fbcamera.h.

Read Write Property: Opacity of foreground.

Definition at line 288 of file fbcamera.h.

Read Write Property: Material threshold for a transparent foreground.

Definition at line 289 of file fbcamera.h.

Read Write Property: Is the foreground transparent?

Definition at line 290 of file fbcamera.h.

FBPropertyTexture FBCamera::ForeGroundTexture [inherited]

Read Write Property: ForeGround Texture

Definition at line 291 of file fbcamera.h.

FBPropertyVideo FBCamera::ForeGroundMedia [inherited]
Deprecated:
Read Write Property: ForeGround Image

Definition at line 292 of file fbcamera.h.

FBPropertyCameraViewPlaneMode FBCamera::ViewForeGroundPlaneMode [inherited]

Read Write Property: Foreground plane view mode

Definition at line 293 of file fbcamera.h.

Read Write Property: Center the foreground image

Definition at line 294 of file fbcamera.h.

Read Write Property: Fit the foreground image

Definition at line 295 of file fbcamera.h.

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

Definition at line 296 of file fbcamera.h.

Read Write Property: Crop the foreground image

Definition at line 297 of file fbcamera.h.

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

Definition at line 298 of file fbcamera.h.

FBPropertyCameraDistanceMode FBCamera::ForeGroundPlaneDistanceMode [inherited]

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

Definition at line 299 of file fbcamera.h.

Read Write Property: Show the camera interest?

Definition at line 302 of file fbcamera.h.

Read Write Property: Show near/far planes?

Definition at line 303 of file fbcamera.h.

Read Write Property: Show name?

Definition at line 304 of file fbcamera.h.

Read Write Property: Show grid?

Definition at line 305 of file fbcamera.h.

Read Write Property: Show axis?

Definition at line 306 of file fbcamera.h.

Read Write Property: Show time code?

Definition at line 307 of file fbcamera.h.

Read Write Property: Display safe area?

Definition at line 308 of file fbcamera.h.

Read Write Property: View optical center?

Definition at line 309 of file fbcamera.h.

FBPropertyCameraSafeAreaMode FBCamera::SafeAreaMode [inherited]

Read Write Property: Select mode for safe area.

Definition at line 310 of file fbcamera.h.

Read Write Property: Background color for camera.

Definition at line 312 of file fbcamera.h.

Read Write Property: Use frame color?

Definition at line 313 of file fbcamera.h.

Read Write Property: Frame color for camera.

Definition at line 314 of file fbcamera.h.

Read Write Property: Use anti-aliasing?

Definition at line 318 of file fbcamera.h.

Read Write Property: Use depth of field calculations?

Definition at line 319 of file fbcamera.h.

Read Write Property: Interactive mode?

Definition at line 320 of file fbcamera.h.

Read Write Property: Anti-aliasing intensity.

Definition at line 323 of file fbcamera.h.

FBPropertyCameraAntiAliasingMethod FBCamera::AntiAliasingMethod [inherited]

Read Write Property: Anti-aliasing method.

Definition at line 324 of file fbcamera.h.

Read Write Property: Number of samples to oversample with.

Definition at line 325 of file fbcamera.h.

FBPropertyCameraSamplingType FBCamera::SamplingType [inherited]

Read Write Property: Type of over sampling.

Definition at line 326 of file fbcamera.h.

Read Write Property: Use accumulation buffer?

Definition at line 327 of file fbcamera.h.

FBPropertyCameraFocusDistanceSource FBCamera::FocusDistanceSource [inherited]

Read Write Property: Select source for focusing.

Definition at line 330 of file fbcamera.h.

Read Write Property: Specfic distance for focusing.

Definition at line 331 of file fbcamera.h.

Read Write Property: Focus Angle (rendering dof).

Definition at line 332 of file fbcamera.h.

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

Definition at line 335 of file fbcamera.h.

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

Definition at line 336 of file fbcamera.h.

Read Write Property: 2D Magnifier Zoom value.

Definition at line 337 of file fbcamera.h.

Read Write Property: 2D Magnifier X Position.

Definition at line 338 of file fbcamera.h.

Read Write Property: 2D Magnifier Y Position.

Definition at line 339 of file fbcamera.h.

FBPropertyModel FBCamera::Interest [inherited]

Read Write Property: Direct camera's interest.

Definition at line 342 of file fbcamera.h.

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

Definition at line 343 of file fbcamera.h.

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

Definition at line 344 of file fbcamera.h.

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

Definition at line 345 of file fbcamera.h.

Read Write Property: Motion Blur Intensity.

Definition at line 348 of file fbcamera.h.

Read Write Property: Enable Motion Blur.

Definition at line 349 of file fbcamera.h.

Read Write Property: Enable Real-time Motion Blur.

Definition at line 350 of file fbcamera.h.

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

Definition at line 353 of file fbcamera.h.

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

Definition at line 354 of file fbcamera.h.

Read Only Property: Camera Viewport width

Definition at line 355 of file fbcamera.h.

Read Only Property: Camera Viewport height

Definition at line 356 of file fbcamera.h.

List : HUDs present in this camera

Definition at line 359 of file fbcamera.h.

List: Children for model.

Definition at line 283 of file fbmodel.h.

List: Shaders for model.

Definition at line 285 of file fbmodel.h.

List: Materials for model.

Definition at line 286 of file fbmodel.h.

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

Definition at line 287 of file fbmodel.h.

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

Definition at line 288 of file fbmodel.h.

Read Write Property: Is model a 3D icon?

Definition at line 289 of file fbmodel.h.

Read Write Property: Is model Soft selected?

Definition at line 290 of file fbmodel.h.

Read Only Property: Is model deformable?

Definition at line 291 of file fbmodel.h.

Read Only Property: Is model constrained?

Definition at line 292 of file fbmodel.h.

Read Write Property: Model skeleton deformable.

Not Savable

Definition at line 293 of file fbmodel.h.

Read Write Property: Model blend-shape deformable.

Not Savable

Definition at line 294 of file fbmodel.h.

Read Write Property: Model constraint deformable.

Not Savable

Definition at line 295 of file fbmodel.h.

Read Write Property: Model point cache deformable.

Not Savable

Definition at line 296 of file fbmodel.h.

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

Definition at line 297 of file fbmodel.h.

FBPropertyModel FBModel::Parent [inherited]

Read Write Property: Parent model.

Definition at line 298 of file fbmodel.h.

FBPropertyModel FBModel::LookAt [inherited]

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

Definition at line 299 of file fbmodel.h.

FBPropertyModel FBModel::UpVector [inherited]

Read Write Property: UpVector model.

Definition at line 300 of file fbmodel.h.

FBPropertyGeometry FBModel::Geometry [inherited]

Read Write Property: Geometry for the model.

Definition at line 301 of file fbmodel.h.

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

Definition at line 302 of file fbmodel.h.

FBPropertyMesh FBModel::TessellatedMesh [inherited]

Read Only Property: Tessellated Mesh for the model.

Definition at line 303 of file fbmodel.h.

FBPropertyModelVertexData FBModel::ModelVertexData [inherited]

Read Only Property: ModelVertexData for the model.

Definition at line 304 of file fbmodel.h.

FBPropertyCluster FBModel::Cluster [inherited]

Read Only Property: Link Cluster for the model.

Definition at line 305 of file fbmodel.h.

FBPropertyScene FBModel::Scene [inherited]

Read Only Property: Scene containing the model.

Definition at line 306 of file fbmodel.h.

FBPropertyModelShadingMode FBModel::ShadingMode [inherited]

Read Write Property: Shading mode for the model.

Definition at line 307 of file fbmodel.h.

FBPropertyAnimationNode FBModel::AnimationNode [inherited]

Read Only Property: Animation node of the model.

Definition at line 308 of file fbmodel.h.

FBPropertyModelRotationOrder FBModel::RotationOrder [inherited]

Read Write Property: Rotation order.

Definition at line 310 of file fbmodel.h.

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

Definition at line 313 of file fbmodel.h.

Read Write Property: Is model using Rotation Limits?

Definition at line 314 of file fbmodel.h.

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

Definition at line 315 of file fbmodel.h.

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

Definition at line 316 of file fbmodel.h.

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

Definition at line 317 of file fbmodel.h.

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

Definition at line 318 of file fbmodel.h.

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

Definition at line 319 of file fbmodel.h.

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

Definition at line 320 of file fbmodel.h.

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

Definition at line 321 of file fbmodel.h.

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

Definition at line 322 of file fbmodel.h.

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

Definition at line 323 of file fbmodel.h.

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

Definition at line 324 of file fbmodel.h.

Read Write Property: Is model using Translation Limits?

Definition at line 326 of file fbmodel.h.

Read Write Property: Translation Limit Min.

Definition at line 327 of file fbmodel.h.

Read Write Property: Translation Limit Max.

Definition at line 328 of file fbmodel.h.

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

Definition at line 329 of file fbmodel.h.

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

Definition at line 330 of file fbmodel.h.

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

Definition at line 331 of file fbmodel.h.

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

Definition at line 332 of file fbmodel.h.

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

Definition at line 333 of file fbmodel.h.

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

Definition at line 334 of file fbmodel.h.

Read Write Property: Visibility of model.

This can be overridden by the 'Show' property.

Definition at line 337 of file fbmodel.h.

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

Definition at line 338 of file fbmodel.h.

Read Write Property: Lcl translation.

Definition at line 339 of file fbmodel.h.

Read Write Property: Lcl rotation.

Definition at line 340 of file fbmodel.h.

Read Write Property: Lcl scaling.

Definition at line 341 of file fbmodel.h.

Read Write Property: Geometric translation.

Definition at line 343 of file fbmodel.h.

Read Write Property: Geometric rotation.

Definition at line 344 of file fbmodel.h.

Read Write Property: Geometric scaling.

Definition at line 345 of file fbmodel.h.

Read Write Property: Use quaternion interpolation.

Definition at line 347 of file fbmodel.h.

Read Write Property: Indicate if the viewer should show the object, according to its visibility value.

This has a default value of 'false'.

Definition at line 349 of file fbmodel.h.

Read Write Property: Indicate if a model can be picked in the viewer.

This has a default value of 'true'.

Definition at line 350 of file fbmodel.h.

Read Write Property: Indicate if a model can be transformable in the viewer.

This has a default value of 'true'.

Definition at line 351 of file fbmodel.h.

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.

Definition at line 352 of file fbmodel.h.

Read Write Property: Control the geometry render state.

Geometry can still cast shadows even if this is turned off.

Definition at line 354 of file fbmodel.h.

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

Definition at line 355 of file fbmodel.h.

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

Definition at line 356 of file fbmodel.h.

const char* FBBox::UniqueName [inherited]

internal Unique name.

Definition at line 293 of file fbcore.h.

Read Write Property: Is the box animatable.

Definition at line 299 of file fbcore.h.

Read Write Property: Is live?

Definition at line 300 of file fbcore.h.

Read Write Property: Is recording?

Definition at line 301 of file fbcore.h.

DataFBComponent* FBComponent::mLocalPtr [inherited]

Handle on DataFBComponent.

Reimplemented in FBCustomManager.

Definition at line 650 of file fbcomponent.h.

FBString FBComponent::mName [protected, inherited]

Name of the component.

Definition at line 653 of file fbcomponent.h.

int FBComponent::TypeInfo [static, inherited]

Contains the Type information of the object.

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

Definition at line 658 of file fbcomponent.h.

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

Definition at line 838 of file fbcomponent.h.

List: List of components.

Reimplemented in FBScene, and FBPropertyInspector.

Definition at line 839 of file fbcomponent.h.

List: Parents.

Definition at line 840 of file fbcomponent.h.

Read Write Property: Selected property.

Definition at line 841 of file fbcomponent.h.

Read Write Property: Unique name of object.

Reimplemented in FBAssetMng, FBConsoleChannel, FBTriggerGroup, FBTrigger, FBMotionClip, and FBTool.

Definition at line 842 of file fbcomponent.h.

Read Write Property: Name and namespace for object.

Definition at line 843 of file fbcomponent.h.

FBPropertyFolder FBComponent::Folder [inherited]

Read Write Property: The folder that contain this component.

Definition at line 846 of file fbcomponent.h.

KObject* FBComponent::mDummyObject [inherited]

Internal Dummy Object for non KObject Components.

Definition at line 871 of file fbcomponent.h.

const char* FBPlug::ClassGroupName [static, inherited]

ClassGroupName of the object.

Definition at line 444 of file fbplug.h.

bool FBPlug::mAllocated [inherited]

Contain the Allocation State of the Component.

Definition at line 450 of file fbplug.h.

int FBPlug::mGlobalTypeInfo [static, protected, inherited]

Represente the Type Index.

Definition at line 500 of file fbplug.h.

HIObject FBPlug::mObject [protected, inherited]

Handle on the Plug.

Definition at line 502 of file fbplug.h.

bool FBPlug::mSDKComponent [protected, inherited]

bool Plug is an SDK component.

Definition at line 503 of file fbplug.h.


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