Show in Contents

Add to Favorites

Home: FBX SDK Programmers Guide

 

 

 

FBX SDK Reference Guide: kfbxlight.h Source File

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXLIGHT_H
#define FBXFILESDK_KFBXPLUGINS_KFBXLIGHT_H

/**************************************************************************************

 Copyright © 2001 - 2008 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.

 The coded instructions, statements, computer programs, and/or related material 
 (collectively the "Data") in these files contain unpublished information 
 proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
 Canada and United States of America federal copyright law and by international 
 treaties. 
 
 The Data may not be disclosed or distributed to third parties, in whole or in
 part, without the prior written consent of Autodesk, Inc. ("Autodesk").

 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
 BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
 NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
 WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
 OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
 
 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
 OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
 SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
 OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
 HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
 FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
 ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
 WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
 OR DAMAGE. 

**************************************************************************************/

#include <fbxfilesdk/components/kbaselib/kaydaradef_h.h>
#include <fbxfilesdk/components/kbaselib/kaydara.h>

#include <fbxfilesdk/kfbxplugins/kfbxnodeattribute.h>
#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxColor;
class KFbxSdkManager;
class KFbxTexture;

class KFBX_DLL KFbxLight : public KFbxNodeAttribute
{
    KFBXOBJECT_DECLARE(KFbxLight,KFbxNodeAttribute);

public:

    virtual EAttributeType GetAttributeType() const;


    typedef enum  
    {
        ePOINT = 0, 
        eDIRECTIONAL, 
        eSPOT
    } ELightType;

    typedef enum  
    {
        eNONE = 0,
        eLINEAR,
        eQUADRATIC,
        eCUBIC
    } EDecayType;

    K_DEPRECATED void SetLightType(ELightType pLightType);

    K_DEPRECATED ELightType GetLightType() const;

    K_DEPRECATED void SetCastLight(bool pCastLight);

    K_DEPRECATED bool GetCastLight() const;

    K_DEPRECATED void SetCastShadows(bool pCastShadows);

    K_DEPRECATED bool GetCastShadows() const;

    K_DEPRECATED void SetShadowColor( KFbxColor& pColor );

    K_DEPRECATED KFbxColor GetShadowColor() const;

    void SetShadowTexture( KFbxTexture* pTexture );

    KFbxTexture* GetShadowTexture() const;



    K_DEPRECATED bool SetFileName(char const* pFileName);
    
#ifdef KARCH_DEV_MACOSX_CFM
    K_DEPRECATED bool SetFile(const FSSpec &pMacFileSpec);
    K_DEPRECATED bool SetFile(const FSRef &pMacFileRef);
    K_DEPRECATED bool SetFile(const CFURLRef &pMacURL);
#endif

    K_DEPRECATED char const* GetFileName() const;

#ifdef KARCH_DEV_MACOSX_CFM
    bool GetFile(FSSpec &pMacFileSpec) const;
    bool GetFile(FSRef &pMacFileRef) const;
    bool GetFile(CFURLRef &pMacURL) const;
#endif


    K_DEPRECATED void SetDecayType( EDecayType pDecayType );

    K_DEPRECATED EDecayType GetDecayType() const;

    K_DEPRECATED void SetDecayStart( double pDist );

    K_DEPRECATED double GetDecayStart() const;

    K_DEPRECATED void SetGroundProjection (bool pEnable);

    K_DEPRECATED bool GetGroundProjection() const;

    K_DEPRECATED void SetVolumetricProjection(bool pEnable);

    K_DEPRECATED bool GetVolumetricProjection() const;

    K_DEPRECATED void SetFrontVolumetricProjection(bool pEnable);

    K_DEPRECATED bool GetFrontVolumetricProjection() const;



    K_DEPRECATED void SetDefaultColor(KFbxColor& pColor);

    K_DEPRECATED KFbxColor& GetDefaultColor(KFbxColor& pColor) const;

    K_DEPRECATED void SetDefaultIntensity(double pIntensity);

    K_DEPRECATED double GetDefaultIntensity() const;

    K_DEPRECATED void SetDefaultConeAngle(double pConeAngle);

    K_DEPRECATED double GetDefaultConeAngle() const;

    K_DEPRECATED void SetDefaultFog(double pFog);

    K_DEPRECATED double GetDefaultFog() const;


    static const char*          sLightType;
    static const char*          sCastLight;
    static const char*          sDrawVolumetricLight;
    static const char*          sDrawGroundProjection;
    static const char*          sDrawFrontFacingVolumetricLight;
    static const char*          sColor;
    static const char*          sIntensity;
    static const char*          sHotSpot; // inner cone
    static const char*          sConeAngle; // outer cone
    static const char*          sFog;
    static const char*          sDecayType;
    static const char*          sDecayStart;
    static const char*          sFileName;
    static const char*          sEnableNearAttenuation;
    static const char*          sNearAttenuationStart;
    static const char*          sNearAttenuationEnd;
    static const char*          sEnableFarAttenuation;
    static const char*          sFarAttenuationStart;
    static const char*          sFarAttenuationEnd;
    static const char*          sCastShadows;
    static const char*          sShadowColor;

    static const ELightType     sDefaultLightType;
    static const fbxBool1       sDefaultCastLight;
    static const fbxBool1       sDefaultDrawVolumetricLight;
    static const fbxBool1       sDefaultDrawGroundProjection;
    static const fbxBool1       sDefaultDrawFrontFacingVolumetricLight;
    static const fbxDouble3     sDefaultColor;
    static const fbxDouble1     sDefaultIntensity;
    static const fbxDouble1     sDefaultHotSpot;
    static const fbxDouble1     sDefaultConeAngle;
    static const fbxDouble1     sDefaultFog;
    static const EDecayType     sDefaultDecayType;
    static const fbxDouble1     sDefaultDecayStart;
    static const fbxString      sDefaultFileName;
    static const fbxBool1       sDefaultEnableNearAttenuation;
    static const fbxDouble1     sDefaultNearAttenuationStart;
    static const fbxDouble1     sDefaultNearAttenuationEnd;
    static const fbxBool1       sDefaultEnableFarAttenuation;
    static const fbxDouble1     sDefaultFarAttenuationStart;
    static const fbxDouble1     sDefaultFarAttenuationEnd;
    static const fbxBool1       sDefaultCastShadows;
    static const fbxDouble3     sDefaultShadowColor;

    //
    // Properties
    //

    
    KFbxTypedProperty<ELightType>       LightType;

    KFbxTypedProperty<fbxBool1>         CastLight;

    KFbxTypedProperty<fbxBool1>         DrawVolumetricLight;

    KFbxTypedProperty<fbxBool1>         DrawGroundProjection;

    KFbxTypedProperty<fbxBool1>         DrawFrontFacingVolumetricLight;

    KFbxTypedProperty<fbxDouble3>       Color;

    KFbxTypedProperty<fbxDouble1>       Intensity;

    KFbxTypedProperty<fbxDouble1>       HotSpot;

    KFbxTypedProperty<fbxDouble1>       ConeAngle;

    KFbxTypedProperty<fbxDouble1>       Fog;

    KFbxTypedProperty<EDecayType>       DecayType;

    KFbxTypedProperty<fbxDouble1>       DecayStart;

    KFbxTypedProperty<fbxString>        FileName;

    KFbxTypedProperty<fbxBool1>         EnableNearAttenuation;

    KFbxTypedProperty<fbxDouble1>       NearAttenuationStart;

    KFbxTypedProperty<fbxDouble1>       NearAttenuationEnd;

    KFbxTypedProperty<fbxBool1>         EnableFarAttenuation;

    KFbxTypedProperty<fbxDouble1>       FarAttenuationStart;

    KFbxTypedProperty<fbxDouble1>       FarAttenuationEnd;

    KFbxTypedProperty<fbxBool1>         CastShadows;

    KFbxTypedProperty<fbxDouble3>       ShadowColor;
    

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is 
//  subject to change without notice.
//

#ifndef DOXYGEN_SHOULD_SKIP_THIS

public:

    // Clone
    virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;

protected:

    KFbxLight(KFbxSdkManager& pManager, char const* pName);
    virtual ~KFbxLight();

    KFbxLight& operator= (KFbxLight const& pLight);

    virtual bool ConstructProperties(bool pForceSet);
    virtual void Destruct(bool pRecursive, bool pDependents);

    virtual void Init();

    virtual KString     GetTypeName() const;
    virtual KStringList GetTypeFlags() const;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

typedef KFbxLight* HKFbxLight;

inline EFbxType FbxTypeOf( KFbxLight::ELightType const &pItem )         { return eENUM; }
inline EFbxType FbxTypeOf( KFbxLight::EDecayType const &pItem )         { return eENUM; }

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXLIGHT_H