fbmodel.h File Reference

This reference page is linked to from the following overview topics: FBModel - Transformation Data and the Scene Graph, FBLight - Lights.


Base class for models. More...

#include <kaydaradef.h>
#include <fbsdk/fbcore.h>
#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbshader.h>

Go to the source code of this file.

Classes

class   FBPropertyListModel
  List: Model More...
class   FBPropertyListMaterial
class   FBPropertyListTexture
class   FBPropertyListDeformer
class   FBModel
  Model class. More...
class   FBModelNull
  Null object class. More...
class   FBModelRoot
  Root object class. More...
class   FBModelMarker
  Model marker class. More...
class   FBModelSkeleton
  Root object class. More...
class   FBModelCube
  Cube model class. More...
class   FBModelPlane
  Plane model class. More...
class   FBModelPath3D
  Path 3D model class. More...
class   FBTexture
  Texture class. More...
class   FBLayeredTexture
  LayeredTexture class. More...
class   FBMaterial
  Material class. More...
class   FBCluster
  Weighting interface for meshes. More...
class   FBCamera
  Creates custom cameras and manages system cameras. More...
class   FBCameraStereo
class   FBPropertyListCamera
  PropertyList: Camera More...
class   FBCameraSwitcher
  Camera switcher. More...
class   FBGlobalLight
  Global light class. More...
class   FBLight
  Light class. More...
class   FBPropertyListLight
  PropertyList: Light More...
class   FBModelVertexData
class   FBGeometry
  Geometry class. More...
class   FBMesh
  Mesh class. More...
class   FBSurface
  Surface class. More...
class   FBNurbs
  Nurbs class. More...
class   FBPatch
  Patch class. More...
class   FBDeformer
  Base Model deformer class. More...
class   FBDeformerPointCache
  Base Model deformer class. More...
class   FBPointCacheFile
  Base Model deformer class. More...

Defines

#define  FBSDK_DLL   K_DLLIMPORT
  Be sure that FBSDK_DLL is defined only once...
#define  FBStorableCustomModelImplementation(ClassName, Type)
  Custom Storable Model Class implementation.

Typedefs

typedef class FBSDK_DLL
FBArrayTemplate< HFBModel > 
FBModelList
  typedef class FBSDK_DLL

Enumerations

enum   FBModelTransformationMatrix {
  kModelTransformation = 1<<0, kModelRotation = 1<<1, kModelTranslation = 1<<2, kModelScaling = 1<<3,
  kModelInverse_Transformation = 1<<4, kModelInverse_Rotation = 1<<5, kModelInverse_Translation = 1<<6, kModelInverse_Scaling = 1<<7,
  kModelParentOffset = 1<<8
}
 

Types of transformation vector/matrices possible.

More...
enum   FBModelShadingMode {
  kFBModelShadingDefault, kFBModelShadingWire, kFBModelShadingFlat, kFBModelShadingLight,
  kFBModelShadingHard, kFBModelShadingTexture, kFBModelShadingAll
}
 

Modes for model shading.

More...
enum   FBModelRenderPass { kFBModelRenderPassStandard, kFBModelRenderPassTransparency, kFBModelRenderPassPick }
 

Model Render pass.

More...
enum   FBModelRotationOrder {
  kFBEulerXYZ = 0, kFBEulerXZY, kFBEulerYZX, kFBEulerYXZ,
  kFBEulerZXY, kFBEulerZYX, kFBSphericXYZ
}
 

Ways to apply Rotation.

More...
enum   FBMarkerResolutionLevel { kFBMarkerLowResolution, kFBMarkerMediumResolution, kFBMarkerHighResolution }
 

Resolution of marker mesh sphere and capsule (Quality).

More...
enum   FBMarkerLook {
  kFBMarkerLookCube, kFBMarkerLookHardCross, kFBMarkerLookLightCross, kFBMarkerLookSphere,
  kFBMarkerLookCapsule, kFBMarkerLookSquare, kFBMarkerLookCircle, kFBMarkerLookBone,
  kFBMarkerLookStick, kFBMarkerLookBox, kFBMarkerLookNone
}
 

Look of the marker.

More...
enum   FBMarkerType { kFBMarkerTypeStandard, kFBMarkerTypeOptical, kFBMarkerTypeFKEffector, kFBMarkerTypeIKEffector }
 

Type of the marker.

More...
enum   FBPathTangeantMode {
  kFBPathTangeantInvalid, kFBPathTangeantLinear, kFBPathTangeantCubic, kFBPathTangeantAuto,
  kFBPathTangeantUser
}
 

Tangeant modes available for path keys.

More...
enum   FBTextureUseType {
  kFBTextureUseColor = 1, kFBTextureUseShadowMap = 2, kFBTextureUseLightMap = 3, kFBTextureUseSphericalReflexionMap = 4,
  kFBTextureUseSphereReflexionMap = 5, kFBTextureUseBumpNormalMap = 6
}
 

Texture Use Type.

More...
enum   FBTextureMapping {
  kFBTextureMappingUV = 1, kFBTextureMappingXY = 2, kFBTextureMappingYZ = 3, kFBTextureMappingXZ = 4,
  kFBTextureMappingSpherical = 5, kFBTextureMappingCylindrical = 6, kFBTextureMappingEnvironment = 7, kFBTextureMappingProjection = 8
}
 

Texture mapping modes.

More...
enum   FBTextureBlendMode { kFBTextureBlendTranslucent, kFBTextureBlendAdditive, kFBTextureBlendModulate, kFBTextureBlendModulate2 }
 

Texture blend modes.

More...
enum   FBMaterialTextureType {
  kFBMaterialTextureEmissive, kFBMaterialTextureEmissiveFactor, kFBMaterialTextureAmbient, kFBMaterialTextureAmbientFactor,
  kFBMaterialTextureDiffuse, kFBMaterialTextureDiffuseFactor, kFBMaterialTextureSpecular, kFBMaterialTextureSpecularFactor,
  kFBMaterialTextureShiness, kFBMaterialTextureBump, kFBMaterialTextureNormalMap, kFBMaterialTextureTransparent,
  kFBMaterialTextureTransparentFactor, kFBMaterialTextureReflection, kFBMaterialTextureReflectionFactor, kFBMaterialTextureDisplacementColor
}
 

Ways to apply Rotation.

More...
enum   FBClusterMode { kFBClusterNormalize, kFBClusterAdditive, kFBClusterTotal100 }
 

Different clustering modes.

More...
enum   FBCameraFrameSizeMode {
  kFBFrameSizeWindow, kFBFrameSizeFixedRatio, kFBFrameSizeFixedResolution, kFBFrameSizeFixedWidthResolution,
  kFBFrameSizeFixedHeightResolution
}
 

Frame size modes.

More...
enum   FBCameraResolutionMode {
  kFBResolutionCustom, kFBResolutionD1NTSC, kFBResolutionNTSC, kFBResolutionPAL,
  kFBResolutionD1PAL, kFBResolutionHD, kFBResolution640x480, kFBResolution320x200,
  kFBResolution320x240, kFBResolution128x128, kFBResolutionFullScreen
}
 

Resolution modes.

More...
enum   FBCameraApertureMode { kFBApertureVertical, kFBApertureHorizontal, kFBApertureVertHoriz, kFBApertureFocalLength }
 

Aperture modes.

More...
enum   FBCameraFilmBackType {
  kFBFilmBackCustom, kFBFilmBack16mmTheatrical, kFBFilmBackSuper16mm, kFBFilmBack35mmAcademy,
  kFBFilmBack35mmTVProjection, kFBFilmBack35mmFullAperture, kFBFilmBack35mm185Projection, kFBFilmBack35mmAnamorphic,
  kFBFilmBack70mmProjection, kFBFilmBackVistaVision, kFBFilmBackDynavision, kFBFilmBackIMAX
}
 

Filmback types.

More...
enum   FBCameraViewPlaneMode { kFBViewPlaneDisabled, kFBViewPlaneAlways, kFBViewPlaneWhenMedia }
 

Camera plane viewing modes.

More...
enum   FBCameraDistanceMode { kFBDistModeRelativeToInterest, kFBDistModeAbsoluteFromCamera }
 

Camera plane distance modes.

More...
enum   FBCameraSafeAreaMode { kFBSafeAreaSquare, kFBSafeAreaRound }
 

Safe area modes.

More...
enum   FBCameraAntiAliasingMethod { kFBAntiAliasingSoftware, kFBAntialiasingMultiSamplingOnyx }
 

Antialiasing methods.

More...
enum   FBCameraSamplingType { kFBSamplingUniform, kFBSamplingStochastic }
 

Antialiasing sampling types.

More...
enum   FBCameraFocusDistanceSource { kFBFocusDistanceCameraInterest, kFBFocusDistanceSpecificDistance }
 

Focus distance sources.

More...
enum   FBCameraType { kFBCameraTypePerspective, kFBCameraTypeOrthogonal }
 

Focus distance types.

More...
enum   FBCameraMatrixType { kFBProjection, kFBModelView }
 

Camera matrix types.

More...
enum   FBCameraStereoType { kFBCameraStereoNone, kFBCameraStereoConverged, kFBCameraStereoOff_Axis, kFBCameraStereoParallel }
enum   FBFogMode { kFBFogModeLinear, kFBFogModeExponential, kFBFogModeSquareExponential }
 

Fog falloff modes.

More...
enum   FBLightType { kFBLightTypePoint, kFBLightTypeInfinite, kFBLightTypeSpot }
 

Light types.

More...
enum   FBAttenuationType { kFBAttenuationNone = 0, kFBAttenuationLinear, kFBAttenuationQuadratic, kFBAttenuationCubic }
 

Light attenuation types.

More...
enum   FBGeometryPrimitiveType {
  kFBGeometry_POINTS = 0x0000, kFBGeometry_LINES = 0x0001, kFBGeometry_LINE_LOOP = 0x0002, kFBGeometry_LINE_STRIP = 0x0003,
  kFBGeometry_TRIANGLES = 0x0004, kFBGeometry_TRIANGLE_STRIP = 0x0005, kFBGeometry_TRIANGLE_FAN = 0x0006, kFBGeometry_QUADS = 0x0007,
  kFBGeometry_QUADS_STRIP = 0x0008, kFBGeometry_POLYGON = 0x0009
}
enum   FBGeometryArrayID {
  kFBGeometryArrayID_Point, kFBGeometryArrayID_NormalByPoint, kFBGeometryArrayID_Tangent, kFBGeometryArrayID_Binormal,
  kFBGeometryArrayID_VertexColor
}
 

ID to use when requesting a specific array of data for a model.

More...
enum   FBGeometryArrayElementType {
  kFBGeometryArrayElementType_Unknown, kFBGeometryArrayElementType_Integer, kFBGeometryArrayElementType_Float, kFBGeometryArrayElementType_Float2,
  kFBGeometryArrayElementType_Float3, kFBGeometryArrayElementType_Float4, kFBGeometryArrayElementType_FloatMatrix4x4, kFBGeometryArrayElementType_IntegerArrayPointer
}
 

Type of data when requesting an array.

More...
enum   FBGeometryMappingMode {
  kFBGeometryMapping_NONE, kFBGeometryMapping_BY_CONTROL_POINT, kFBGeometryMapping_BY_POLYGON_VERTEX, kFBGeometryMapping_BY_POLYGON,
  kFBGeometryMapping_BY_EDGE, kFBGeometryMapping_ALL_SAME
}
 

Determine how the element is mapped on a surface.

More...
enum   FBGeometryReferenceMode { kFBGeometryReference_DIRECT, kFBGeometryReference_INDEX, kFBGeometryReference_INDEX_TO_DIRECT }
 

Determine how the mapping information is stored in the array of coordinate.

More...
enum   kFBGeometryUpdateFlags {
  kFBGeometryUpdateNone = 0, kFBGeometryUpdateAll = 1 << 0, kFBGeometryUpdatePositionAndNormal = 1 << 1, kFBGeometryUpdateSkinWeight = 1 << 2,
  kFBGeometryUpdateInverseNormal = 1 << 3, kFBGeometryUpdateMappingMode = 1 << 4
}
enum   FBSurfaceMode {
  kFBSurfaceModeRaw, kFBSurfaceModeLowNoNormals, kFBSurfaceModeLow, kFBSurfaceModeHighNoNormals,
  kFBSurfaceModeHigh
}
 

Surface modes.

More...
enum   FBSurfaceType {
  kFBSurfaceTypeBezier, kFBSurfaceTypeBezierQuadric, kFBSurfaceTypeCardinal, kFBSurfaceTypeBspline,
  kFBSurfaceTypeLinear
}
 

Surface types.

More...
enum   FBNurbType { kFBNurbTypePeriodic, kFBNurbTypeClosed, kFBNurbTypeOpen }
 

Surface types.

More...
enum   FBDeformerType { kFBDeformerUnkown, kFBDeformerSkeleton, kFBDeformerPointCache }
 

Determine the deformer type.

More...

Functions

  FB_DEFINE_COMPONENT (FBSDK_DLL, Camera)
  FB_DEFINE_COMPONENT (FBSDK_DLL, CameraStereo)
  FB_DEFINE_COMPONENT (FBSDK_DLL, Light)
  FB_DEFINE_COMPONENT (FBSDK_DLL, Model)
  FB_DEFINE_COMPONENT (FBSDK_DLL, Cluster)
  FB_DEFINE_COMPONENT (FBSDK_DLL, Geometry)
  FB_DEFINE_COMPONENT (FBSDK_DLL, Mesh)
  FB_DEFINE_COMPONENT (FBSDK_DLL, ModelVertexData)
  FB_DEFINE_COMPONENT (FBSDK_DLL, Video)
  FB_DEFINE_COMPONENT (FBSDK_DLL, PointCacheFile)
  FB_DEFINE_COMPONENT (FBSDK_DLL, AnimationNode)
FBSDK_DLL void  FBModelTransactionBegin ()
  FBModelTransactionBegin.
FBSDK_DLL void  FBModelTransactionEnd ()
  FBModelTransactionEnd.
  __FB_FORWARD (FBModel)
  __FB_FORWARD (FBPropertyListModel)
  FB_DEFINE_LIST (FBSDK_DLL, Model)
  __FB_FORWARD (FBMaterial)
  PropertyList: Material
  __FB_FORWARD (FBTexture)
  PropertyList: Texture
  __FB_FORWARD (FBDeformer)
  PropertyList: Texture
  FB_DEFINE_ENUM (FBSDK_DLL, ModelShadingMode)
  FB_DEFINE_ENUM (FBSDK_DLL, ModelTransformationMatrix)
  FB_DEFINE_ENUM (FBSDK_DLL, ModelRotationOrder)
  __FB_FORWARD (FBModelNull)
  __FB_FORWARD (FBModelRoot)
  __FB_FORWARD (FBModelMarker)
  FB_DEFINE_ENUM (FBSDK_DLL, MarkerResolutionLevel)
  FB_DEFINE_ENUM (FBSDK_DLL, MarkerLook)
  FB_DEFINE_ENUM (FBSDK_DLL, MarkerType)
  __FB_FORWARD (FBModelSkeleton)
  __FB_FORWARD (FBModelCube)
  __FB_FORWARD (FBModelPlane)
  __FB_FORWARD (FBModelPath3D)
  FB_DEFINE_ENUM (FBSDK_DLL, PathTangeantMode)
  FB_DEFINE_ENUM (FBSDK_DLL, TextureUseType)
  FB_DEFINE_ENUM (FBSDK_DLL, TextureMapping)
  FB_DEFINE_ENUM (FBSDK_DLL, TextureBlendMode)
  __FB_FORWARD (FBLayeredTexture)
  FB_DEFINE_ENUM (FBSDK_DLL, ClusterMode)
  __FB_FORWARD (FBCluster)
  __FB_FORWARD (FBCamera)
  FB_DEFINE_ENUM (FBSDK_DLL, CameraType)
  FB_DEFINE_ENUM (FBSDK_DLL, CameraApertureMode)
  FB_DEFINE_ENUM (FBSDK_DLL, CameraFilmBackType)
  FB_DEFINE_ENUM (FBSDK_DLL, CameraFrameSizeMode)
  FB_DEFINE_ENUM (FBSDK_DLL, CameraResolutionMode)
  FB_DEFINE_ENUM (FBSDK_DLL, CameraViewPlaneMode)
  FB_DEFINE_ENUM (FBSDK_DLL, CameraDistanceMode)
  FB_DEFINE_ENUM (FBSDK_DLL, CameraSafeAreaMode)
  FB_DEFINE_ENUM (FBSDK_DLL, CameraAntiAliasingMethod)
  FB_DEFINE_ENUM (FBSDK_DLL, CameraSamplingType)
  FB_DEFINE_ENUM (FBSDK_DLL, CameraFocusDistanceSource)
  FB_DEFINE_ENUM (FBSDK_DLL, CameraMatrixType)
  __FB_FORWARD (FBCameraStereo)
  FB_DEFINE_ENUM (FBSDK_DLL, CameraStereoType)
  __FB_FORWARD (FBCameraSwitcher)
  __FB_FORWARD (FBGlobalLight)
  FB_DEFINE_ENUM (FBSDK_DLL, FogMode)
  __FB_FORWARD (FBLight)
  FB_DEFINE_ENUM (FBSDK_DLL, LightType)
  FB_DEFINE_ENUM (FBSDK_DLL, AttenuationType)
  __FB_FORWARD (FBModelVertexData)
  __FB_FORWARD (FBGeometry)
  FB_DEFINE_ENUM (FBSDK_DLL, GeometryMappingMode)
  FB_DEFINE_ENUM (FBSDK_DLL, GeometryReferenceMode)
  __FB_FORWARD (FBMesh)
  __FB_FORWARD (FBSurface)
  FB_DEFINE_ENUM (FBSDK_DLL, SurfaceMode)
  FB_DEFINE_ENUM (FBSDK_DLL, SurfaceType)
  FB_DEFINE_ENUM (FBSDK_DLL, NurbType)
  __FB_FORWARD (FBNurbs)
  __FB_FORWARD (FBPatch)
  FB_DEFINE_ENUM (FBSDK_DLL, DeformerType)
  __FB_FORWARD (FBDeformerPointCache)
  __FB_FORWARD (FBPointCacheFile)

Detailed Description

Base class for models.

Definition in file fbmodel.h.


Define Documentation

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbmodel.h.

#define FBStorableCustomModelImplementation (   ClassName,
  Type 
)
Value:
char* ClassName::FbxGetObjectSubType(){ return #ClassName; }\
    HIObject RegisterStorable##ClassName##Create(HIObject /*pOwner*/, char* pName, void* /*pData*/){\
        ClassName* Class = new ClassName(pName);\
        Class->mAllocated = true;\
        Class->EnableObjectFlags(kFBFlagCustomNode);\
        if( Class->FBCreate() ){\
            return Class->GetHIObject();\
        } else {\
            delete Class;\
            return NULL;}}\
    FBLibraryModule(ClassName##Storable){\
        FBString lGroup = "FbxStorable/";\
        lGroup += #Type;\
        FBRegisterObject(ClassName##R2, lGroup, #ClassName, "", RegisterStorable##ClassName##Create, true, NULL);\
        FBSetStoreableCustomModelReigstered();}\

Custom Storable Model Class implementation.

This should be placed in the source code file for a custom model class.

Definition at line 66 of file fbmodel.h.


Typedef Documentation

typedef class FBSDK_DLL FBArrayTemplate<HFBModel> FBModelList

typedef class FBSDK_DLL

Definition at line 84 of file fbmodel.h.


Enumeration Type Documentation

Types of transformation vector/matrices possible.

Enumerator:
kModelTransformation 

Transformation.

kModelRotation 

Rotation.

kModelTranslation 

Translation.

kModelScaling 

Scaling.

kModelInverse_Transformation 

Inverse transformation.

kModelInverse_Rotation 

Inverse rotation.

kModelInverse_Translation 

Inverse translation.

kModelInverse_Scaling 

Inverse scaling.

kModelParentOffset 

Computes local transformation matrix from parent.

Definition at line 231 of file fbmodel.h.

Modes for model shading.

Enumerator:
kFBModelShadingDefault 

Default shading.

kFBModelShadingWire 

Wireframe shading.

kFBModelShadingFlat 

Flat shading.

kFBModelShadingLight 

Lighted shading.

kFBModelShadingHard 

Hard shading.

kFBModelShadingTexture 

Textured shading.

kFBModelShadingAll 

Lighted, shaded, textured shading.

Definition at line 244 of file fbmodel.h.

Model Render pass.

Enumerator:
kFBModelRenderPassStandard 

Standard pass.

kFBModelRenderPassTransparency 

Transparency pass.

kFBModelRenderPassPick 

Pick pass.

Definition at line 255 of file fbmodel.h.

Ways to apply Rotation.

Enumerator:
kFBEulerXYZ 

XYZ Euler Order.

kFBEulerXZY 

XZY Euler Order.

kFBEulerYZX 

YZX Euler Order.

kFBEulerYXZ 

YXZ Euler Order.

kFBEulerZXY 

ZXY Euler Order.

kFBEulerZYX 

ZYX Euler Order.

kFBSphericXYZ 

Spheric XYZ Order.

Definition at line 262 of file fbmodel.h.

Resolution of marker mesh sphere and capsule (Quality).

Enumerator:
kFBMarkerLowResolution 

Lowest resolution.

kFBMarkerMediumResolution 

Medium resolution.

kFBMarkerHighResolution 

Highest resolution.

Definition at line 568 of file fbmodel.h.

Look of the marker.

Enumerator:
kFBMarkerLookCube 

Cube.

kFBMarkerLookHardCross 

Thick cross.

kFBMarkerLookLightCross 

Wireframe cross.

kFBMarkerLookSphere 

Sphere.

kFBMarkerLookCapsule 

Capsule.

kFBMarkerLookSquare 

Square.

kFBMarkerLookCircle 

Circle.

kFBMarkerLookBone 

Bone.

kFBMarkerLookStick 

Box with a sphere on one end.

kFBMarkerLookBox 

Box.

kFBMarkerLookNone 

None.

Definition at line 576 of file fbmodel.h.

Type of the marker.

Enumerator:
kFBMarkerTypeStandard 

Standard.

kFBMarkerTypeOptical 

Optical.

kFBMarkerTypeFKEffector 

FK effector.

kFBMarkerTypeIKEffector 

IK effector.

Definition at line 592 of file fbmodel.h.

Tangeant modes available for path keys.

Enumerator:
kFBPathTangeantInvalid 

Invalid tangeant.

kFBPathTangeantLinear 

Linear tangeant.

kFBPathTangeantCubic 

Cubic tangeant.

kFBPathTangeantAuto 

Automatic-cubic tangeant.

kFBPathTangeantUser 

User-cubic tangeant.

Definition at line 693 of file fbmodel.h.

Texture Use Type.

How the texture is used.

Enumerator:
kFBTextureUseColor 

standard color type, work with material.

kFBTextureUseShadowMap 

Shadow Map, work with model.

kFBTextureUseLightMap 

Light Map, work with model.

kFBTextureUseSphericalReflexionMap 

Spherical Reflexion Map, work with model.

kFBTextureUseSphereReflexionMap 

Sphere Reflexion Map, work with model.

kFBTextureUseBumpNormalMap 

Bump Normal Map, work with model.

Definition at line 818 of file fbmodel.h.

Texture mapping modes.

How the texture is mapped.

Enumerator:
kFBTextureMappingUV 

UV mapping.

kFBTextureMappingXY 

XY mapping.

kFBTextureMappingYZ 

YZ mapping.

kFBTextureMappingXZ 

XZ mapping.

kFBTextureMappingSpherical 

Spherical mapping.

kFBTextureMappingCylindrical 

Cylindrical mapping.

kFBTextureMappingEnvironment 

Environment mapping.

kFBTextureMappingProjection 

Projection mapping.

Definition at line 830 of file fbmodel.h.

Texture blend modes.

How the texture is blended with another.

Enumerator:
kFBTextureBlendTranslucent 

Layer transparency.

kFBTextureBlendAdditive 

Layer addition.

kFBTextureBlendModulate 

Layer multiplication.

kFBTextureBlendModulate2 

Layer multiplication + brightness.

Definition at line 844 of file fbmodel.h.

Ways to apply Rotation.

Enumerator:
kFBMaterialTextureEmissive 
kFBMaterialTextureEmissiveFactor 
kFBMaterialTextureAmbient 
kFBMaterialTextureAmbientFactor 
kFBMaterialTextureDiffuse 
kFBMaterialTextureDiffuseFactor 
kFBMaterialTextureSpecular 
kFBMaterialTextureSpecularFactor 
kFBMaterialTextureShiness 
kFBMaterialTextureBump 
kFBMaterialTextureNormalMap 
kFBMaterialTextureTransparent 
kFBMaterialTextureTransparentFactor 
kFBMaterialTextureReflection 
kFBMaterialTextureReflectionFactor 
kFBMaterialTextureDisplacementColor 

Definition at line 931 of file fbmodel.h.

Different clustering modes.

Enumerator:
kFBClusterNormalize 

Normalize (values between 0.0 and 1.0 )

kFBClusterAdditive 

Add the values together.

kFBClusterTotal100 

The balanced values will add up to 100 percent.

Definition at line 1013 of file fbmodel.h.

Frame size modes.

Enumerator:
kFBFrameSizeWindow 

Frame size of window.

kFBFrameSizeFixedRatio 

Fixed ratio.

kFBFrameSizeFixedResolution 

Fixed resolution.

kFBFrameSizeFixedWidthResolution 

Fixed width resolution.

kFBFrameSizeFixedHeightResolution 

Fixed height resolution.

Definition at line 1152 of file fbmodel.h.

Resolution modes.

Enumerator:
kFBResolutionCustom 

Custom resolution mode or From Camera as a render setting.

kFBResolutionD1NTSC 

D1 NTSC.

kFBResolutionNTSC 

NTSC.

kFBResolutionPAL 

PAL.

kFBResolutionD1PAL 

D1 PAL.

kFBResolutionHD 

HD 1920x1080.

kFBResolution640x480 

640x480.

kFBResolution320x200 

320x200.

kFBResolution320x240 

320x240.

kFBResolution128x128 

128x128.

kFBResolutionFullScreen 

FullScreen.

Definition at line 1161 of file fbmodel.h.

Aperture modes.

Enumerator:
kFBApertureVertical 

Vertical aperture varies.

kFBApertureHorizontal 

Horizontal aperture varies.

kFBApertureVertHoriz 

Vertical and horizontal aperture varies.

kFBApertureFocalLength 

Focal Length aperture varies.

Definition at line 1176 of file fbmodel.h.

Filmback types.

Enumerator:
kFBFilmBackCustom 

Custom Filmback.

kFBFilmBack16mmTheatrical 

16mm Theatrical.

kFBFilmBackSuper16mm 

Super16mm.

kFBFilmBack35mmAcademy 

35mm Academy.

kFBFilmBack35mmTVProjection 

35mm TV Projection.

kFBFilmBack35mmFullAperture 

35mm Full Aperture.

kFBFilmBack35mm185Projection 

35mm 185 Projection.

kFBFilmBack35mmAnamorphic 

35mm Anamorphic.

kFBFilmBack70mmProjection 

70mm Projection.

kFBFilmBackVistaVision 

Vista Vision.

kFBFilmBackDynavision 

Dynavision.

kFBFilmBackIMAX 

IMAX.

Definition at line 1184 of file fbmodel.h.

Camera plane viewing modes.

Enumerator:
kFBViewPlaneDisabled 

Camera plane disabled.

kFBViewPlaneAlways 

Always draw camera plane.

kFBViewPlaneWhenMedia 

Camera plane when media.

Definition at line 1200 of file fbmodel.h.

Camera plane distance modes.

Enumerator:
kFBDistModeRelativeToInterest 

Camera plane distance relative to interest.

kFBDistModeAbsoluteFromCamera 

Camera plane distance absolute from camera.

Definition at line 1207 of file fbmodel.h.

Safe area modes.

Enumerator:
kFBSafeAreaSquare 

Square safe area.

kFBSafeAreaRound 

Round safe area.

Definition at line 1213 of file fbmodel.h.

Antialiasing methods.

Enumerator:
kFBAntiAliasingSoftware 

Antaliasing in software.

kFBAntialiasingMultiSamplingOnyx 

Multisampling (only on Onyx).

Definition at line 1219 of file fbmodel.h.

Antialiasing sampling types.

Enumerator:
kFBSamplingUniform 

Uniform sampling.

kFBSamplingStochastic 

Stochastic sampling.

Definition at line 1225 of file fbmodel.h.

Focus distance sources.

Enumerator:
kFBFocusDistanceCameraInterest 

Interest as source.

kFBFocusDistanceSpecificDistance 

Specific distance as source.

Definition at line 1231 of file fbmodel.h.

Focus distance types.

Enumerator:
kFBCameraTypePerspective 

Interest as source.

kFBCameraTypeOrthogonal 

Specific distance as source.

Definition at line 1238 of file fbmodel.h.

Camera matrix types.

Enumerator:
kFBProjection 

Projection View matrix (OpenGL).

kFBModelView 

Model View matrix (OpenGL).

Definition at line 1245 of file fbmodel.h.

enum FBFogMode

Fog falloff modes.

Enumerator:
kFBFogModeLinear 

Linear falloff.

kFBFogModeExponential 

Exponential falloff.

kFBFogModeSquareExponential 

Squared exponential falloff.

Definition at line 1483 of file fbmodel.h.

Light types.

Enumerator:
kFBLightTypePoint 

Point light.

kFBLightTypeInfinite 

Infinite light (plane).

kFBLightTypeSpot 

Spotlight.

Definition at line 1518 of file fbmodel.h.

Light attenuation types.

Enumerator:
kFBAttenuationNone 

No attenuation.

kFBAttenuationLinear 

Linear attenuation.

kFBAttenuationQuadratic 

Quadratic attenuation.

kFBAttenuationCubic 

Cubic attenuation.

Definition at line 1528 of file fbmodel.h.

Enumerator:
kFBGeometry_POINTS 
kFBGeometry_LINES 
kFBGeometry_LINE_LOOP 
kFBGeometry_LINE_STRIP 
kFBGeometry_TRIANGLES 
kFBGeometry_TRIANGLE_STRIP 
kFBGeometry_TRIANGLE_FAN 
kFBGeometry_QUADS 
kFBGeometry_QUADS_STRIP 
kFBGeometry_POLYGON 

Definition at line 1584 of file fbmodel.h.

{
    kFBGeometry_POINTS          = 0x0000, //GL_POINTS,
    kFBGeometry_LINES           = 0x0001, //GL_LINES,
    kFBGeometry_LINE_LOOP       = 0x0002, //GL_LINE_LOOP,
    kFBGeometry_LINE_STRIP      = 0x0003, //GL_LINE_STRIP,
    kFBGeometry_TRIANGLES       = 0x0004, //GL_TRIANGLES,
    kFBGeometry_TRIANGLE_STRIP  = 0x0005, //GL_TRIANGLE_STRIP,
    kFBGeometry_TRIANGLE_FAN    = 0x0006, //GL_TRIANGLE_FAN,
    kFBGeometry_QUADS           = 0x0007, //GL_QUADS,
    kFBGeometry_QUADS_STRIP     = 0x0008, //GL_QUAD_STRIP,
    kFBGeometry_POLYGON         = 0x0009, //GL_POLYGON,
};

ID to use when requesting a specific array of data for a model.

Enumerator:
kFBGeometryArrayID_Point 

ID to the Point array.

kFBGeometryArrayID_NormalByPoint 

ID to the Normal by Point array.

kFBGeometryArrayID_Tangent 

ID to the Tangent array.

kFBGeometryArrayID_Binormal 

ID to the Binormal array.

kFBGeometryArrayID_VertexColor 

ID to the Vertex Color Array.

Definition at line 1599 of file fbmodel.h.

Type of data when requesting an array.

Enumerator:
kFBGeometryArrayElementType_Unknown 
kFBGeometryArrayElementType_Integer 
kFBGeometryArrayElementType_Float 
kFBGeometryArrayElementType_Float2 
kFBGeometryArrayElementType_Float3 

Each element is an array of 3 float.

kFBGeometryArrayElementType_Float4 

Each element is an array of 4 float.

kFBGeometryArrayElementType_FloatMatrix4x4 
kFBGeometryArrayElementType_IntegerArrayPointer 

Definition at line 1608 of file fbmodel.h.

Determine how the element is mapped on a surface.

  • kFBGeometryMapping_NONE The mapping is undetermined.
  • kFBGeometryMapping_BY_CONTROL_POINT There will be one mapping coordinate for each surface control point/vertex.
  • kFBGeometryMapping_BY_POLYGON_VERTEX There will be one mapping coordinate for each vertex, for each polygon/strip it is part of. This means that a vertex will have as many mapping coordinates as polygons it is part of.
  • kFBGeometryMapping_BY_POLYGON There can be only one mapping coordinate for the whole polygon/strip.
  • kFBGeometryMapping_BY_EDGE There will be one mapping coordinate for each unique edge in the mesh. This is meant to be used with smoothing layer elements.
  • kFBGeometryMapping_ALL_SAME There can be only one mapping coordinate for the whole surface.
Enumerator:
kFBGeometryMapping_NONE 
kFBGeometryMapping_BY_CONTROL_POINT 
kFBGeometryMapping_BY_POLYGON_VERTEX 
kFBGeometryMapping_BY_POLYGON 
kFBGeometryMapping_BY_EDGE 
kFBGeometryMapping_ALL_SAME 

Definition at line 1819 of file fbmodel.h.

Determine how the mapping information is stored in the array of coordinate.

  • kFBGeometryReference_DIRECT This indicates that the mapping information for the n'th element is found in the n'th place of DirectArray.
  • kFBGeometryReference_INDEX, This indicates that the mapping information for the n'th element is found in the n'th place of IndexArray.
  • kFBGeometryReference_INDEX_TO_DIRECT This indicates that the KLayerElementTemplate::mIndexArray contains, for the n'th element, an index in the KLayerElementTemplate::mDirectArray array of mapping elements. eINDEX_TO_DIRECT is usually useful to store coordinates for eBY_POLYGON_VERTEX mapping mode elements. Since the same coordinates are usually repeated a large number of times, it saves spaces to store the coordinate only one time and refer to them with an index. Materials and Textures are also referenced with this mode and the actual Material/Texture can be accessed via the KLayerElementTemplate::mDirectArray
Enumerator:
kFBGeometryReference_DIRECT 
kFBGeometryReference_INDEX 
kFBGeometryReference_INDEX_TO_DIRECT 

Definition at line 1840 of file fbmodel.h.

Enumerator:
kFBGeometryUpdateNone 

no update done

kFBGeometryUpdateAll 

control point add/remove, topology change, cluster/shape change and such events requiring regenerate optimized strip.

kFBGeometryUpdatePositionAndNormal 

only control point's position & normal change, so only update those values in the strip.

kFBGeometryUpdateSkinWeight 

update skin weight

kFBGeometryUpdateInverseNormal 

inverse normal request.

kFBGeometryUpdateMappingMode 

mapping mode request from associated shading network change.

Definition at line 1850 of file fbmodel.h.

Surface modes.

Enumerator:
kFBSurfaceModeRaw 

Raw data.

kFBSurfaceModeLowNoNormals 

Low quality, no normals.

kFBSurfaceModeLow 

Low quality.

kFBSurfaceModeHighNoNormals 

High quality, no normals.

kFBSurfaceModeHigh 

High quality.

Definition at line 2328 of file fbmodel.h.

Surface types.

Enumerator:
kFBSurfaceTypeBezier 

Bezier surface.

kFBSurfaceTypeBezierQuadric 

Bezier Quadric surface.

kFBSurfaceTypeCardinal 

Cardinal surface.

kFBSurfaceTypeBspline 

BSpline surface.

kFBSurfaceTypeLinear 

Linear surface.

Definition at line 2339 of file fbmodel.h.

enum FBNurbType

Surface types.

Enumerator:
kFBNurbTypePeriodic 

Periodic Type Nurb.

kFBNurbTypeClosed 

Closed Type Nurb.

kFBNurbTypeOpen 

Open Type Nurb.

Definition at line 2426 of file fbmodel.h.

Determine the deformer type.

  • kFBDeformerSkeleton Skeleton (Bone) driven skinning deformer.
  • kFBDeformerPointCache Pre-recorded point cache deformer.
  • kFBGeometryMapping_BY_POLYGON_VERTEX There will be one mapping coordinate for each vertex, for each polygon/strip it is part of. This means that a vertex will have as many mapping coordinates as polygons it is part of.
  • kFBGeometryMapping_BY_POLYGON There can be only one mapping coordinate for the whole polygon/strip.
  • kFBGeometryMapping_BY_EDGE There will be one mapping coordinate for each unique edge in the mesh. This is meant to be used with smoothing layer elements.
  • kFBGeometryMapping_ALL_SAME There can be only one mapping coordinate for the whole surface.
Enumerator:
kFBDeformerUnkown 
kFBDeformerSkeleton 
kFBDeformerPointCache 

Definition at line 2583 of file fbmodel.h.


Function Documentation

FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
Camera   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
CameraStereo   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
Light   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
Model   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
Cluster   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
Geometry   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
Mesh   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
ModelVertexData   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
Video   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
PointCacheFile   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
AnimationNode   
)
FBSDK_DLL void FBModelTransactionBegin ( )

FBModelTransactionBegin.

This set of functions speeds up the process of batch operations on models.

FBSDK_DLL void FBModelTransactionEnd ( )

FBModelTransactionEnd.

This set of functions speeds up the process of batch operations on models.

__FB_FORWARD ( FBModel  )
FB_DEFINE_LIST ( FBSDK_DLL  ,
Model   
)
__FB_FORWARD ( FBMaterial  )

PropertyList: Material

__FB_FORWARD ( FBTexture  )

PropertyList: Texture

__FB_FORWARD ( FBDeformer  )

PropertyList: Texture

FB_DEFINE_ENUM ( FBSDK_DLL  ,
ModelShadingMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
ModelTransformationMatrix   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
ModelRotationOrder   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
MarkerResolutionLevel   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
MarkerLook   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
MarkerType   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
PathTangeantMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
TextureUseType   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
TextureMapping   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
TextureBlendMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
ClusterMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CameraType   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CameraApertureMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CameraFilmBackType   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CameraFrameSizeMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CameraResolutionMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CameraViewPlaneMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CameraDistanceMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CameraSafeAreaMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CameraAntiAliasingMethod   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CameraSamplingType   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CameraFocusDistanceSource   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CameraMatrixType   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CameraStereoType   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
FogMode   
)
__FB_FORWARD ( FBLight  )
FB_DEFINE_ENUM ( FBSDK_DLL  ,
LightType   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
AttenuationType   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
GeometryMappingMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
GeometryReferenceMode   
)
__FB_FORWARD ( FBMesh  )
FB_DEFINE_ENUM ( FBSDK_DLL  ,
SurfaceMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
SurfaceType   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
NurbType   
)
__FB_FORWARD ( FBNurbs  )
__FB_FORWARD ( FBPatch  )
FB_DEFINE_ENUM ( FBSDK_DLL  ,
DeformerType   
)