kfbxlight.h

Go to the documentation of this file.

#ifndef _FBXSDK_LIGHT_H_
#define _FBXSDK_LIGHT_H_

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

 Copyright © 2001 - 2007 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 <kaydaradef.h>
#ifndef KFBX_DLL 
    #define KFBX_DLL K_DLLIMPORT
#endif

#include <kaydara.h>

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

class KFbxColor;
class KFbxSdkManager;
class KFbxTexture;
class KFbxLight_internal;

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

public:

    virtual EAttributeType GetAttributeType() const;

    static const char* sDecayType;
    static const char* sDecayStart;
    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;



    typedef enum  
    {
        ePOINT, 
        eDIRECTIONAL, 
        eSPOT
    } ELightType;

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

    void SetLightType(ELightType pLightType);

    ELightType GetLightType() const;

    void SetCastLight(bool pCastLight);

    bool GetCastLight() const;

    void SetCastShadows(bool pCastShadows);

    bool GetCastShadows() const;

    void SetShadowColor( KFbxColor& pColor );

    KFbxColor GetShadowColor() const;

    void SetShadowTexture( KFbxTexture* pTexture );

    KFbxTexture* GetShadowTexture() const;



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

    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


    void SetDecayType( EDecayType pDecayType );

    EDecayType GetDecayType() const;

    void SetDecayStart( double pDist );

    double GetDecayStart() const;

    void SetGroundProjection (bool pEnable);

    bool GetGroundProjection() const;

    void SetVolumetricProjection(bool pEnable);

    bool GetVolumetricProjection() const;

    void SetFrontVolumetricProjection(bool pEnable);

    bool GetFrontVolumetricProjection() const;



    void SetDefaultColor(KFbxColor& pColor);

    KFbxColor& GetDefaultColor(KFbxColor& pColor) const;

    void SetDefaultIntensity(double pIntensity);

    double GetDefaultIntensity() const;

    void SetDefaultConeAngle(double pConeAngle);

    double GetDefaultConeAngle() const;

    void SetDefaultFog(double pFog);

    double GetDefaultFog() const;



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

#ifndef DOXYGEN_SHOULD_SKIP_THIS

public:

    virtual KObject*  GetFbxObject_internal();
    virtual KObject const*  GetFbxObject_internal() const;

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

protected:
    static char const* GetNamePrefix() { return 0; }

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

    KFbxLight& operator= (KFbxLight const& pLight);

    virtual void Destruct(bool pRecursive, bool pDependents);

    virtual void AddChannels(KFbxTakeNode *pTakeNode);

    virtual void RemoveChannels(KFbxTakeNode *pTakeNode);

    virtual void Init();

    virtual bool FbxPlugNotify(KFbxPlugEvent const &pEvent);

    KFbxLight_internal* mPH;

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

    KString mFileName;  

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

typedef KFbxLight* HKFbxLight;

#include <fbxfilesdk_nsend.h>

#endif // #ifndef _FBXSDK_LIGHT_H_