Public API Reference

iengine/light.h

Go to the documentation of this file.

/*
    Copyright (C) 2000-2001 by Jorrit Tyberghein
    Copyright (C) 1999 by Andrew Zabolotny <[email protected]>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_IENGINE_LIGHT_H__
#define __CS_IENGINE_LIGHT_H__

#include "csutil/scf.h"

#include "iengine/fview.h"

class csColor;
class csFlags;
class csVector3;

struct iLight;
struct iLightingInfo;
struct iMovable;
struct iObject;
struct iSector;
struct iSceneNode;
struct iShaderVariableContext;

struct iBaseHalo;
struct iCrossHalo;
struct iNovaHalo;
struct iFlareHalo;

#define CS_LIGHT_ACTIVEHALO     0x80000000

enum csLightDynamicType
{
  CS_LIGHT_DYNAMICTYPE_STATIC = 1, 
 
  CS_LIGHT_DYNAMICTYPE_PSEUDO = 2,

  CS_LIGHT_DYNAMICTYPE_DYNAMIC = 3
};

#define CS_DEFAULT_LIGHT_LEVEL 20
#define CS_NORMAL_LIGHT_LEVEL 128

enum csLightAttenuationMode
{
  CS_ATTN_NONE = 0,
  CS_ATTN_LINEAR = 1,
  CS_ATTN_INVERSE = 2,
  CS_ATTN_REALISTIC = 3,
  CS_ATTN_CLQ = 4
};
enum csLightType
{
  CS_LIGHT_POINTLIGHT,
  CS_LIGHT_DIRECTIONAL,
  CS_LIGHT_SPOTLIGHT
};

struct iLightCallback : public virtual iBase
{
  SCF_INTERFACE(iLightCallback,2,0,0);
  virtual void OnColorChange (iLight* light, const csColor& newcolor) = 0;

  virtual void OnPositionChange (iLight* light, const csVector3& newpos) = 0;

  virtual void OnSectorChange (iLight* light, iSector* newsector) = 0;

  virtual void OnRadiusChange (iLight* light, float newradius) = 0;

  virtual void OnDestroy (iLight* light) = 0;

  virtual void OnAttenuationChange (iLight* light, int newatt) = 0;
};


struct iLight : public virtual iBase
{
  SCF_INTERFACE(iLight,2,0,0);
  virtual const char* GetLightID () = 0;

  virtual iObject *QueryObject() = 0;

  virtual csLightDynamicType GetDynamicType () const = 0;

  virtual const csVector3& GetCenter () const = 0;
  virtual const csVector3 GetFullCenter () const = 0;
  virtual void SetCenter (const csVector3& pos) = 0;

  virtual iSector *GetSector () = 0;

  virtual iMovable *GetMovable () = 0;

  virtual iSceneNode* QuerySceneNode () = 0;

  virtual const csColor& GetColor () const = 0;
  virtual void SetColor (const csColor& col) = 0;

  virtual const csColor& GetSpecularColor () const = 0;
  virtual void SetSpecularColor (const csColor& col) = 0;
  
  virtual csLightType GetType () const = 0;
  virtual void SetType (csLightType type) = 0;

  virtual csLightAttenuationMode GetAttenuationMode () const = 0;
  virtual void SetAttenuationMode (csLightAttenuationMode a) = 0;

  virtual void SetAttenuationConstants (const csVector3& constants) = 0;
  virtual const csVector3 &GetAttenuationConstants () const = 0;

  virtual float GetCutoffDistance () const = 0;

  virtual void SetCutoffDistance (float distance) = 0;

  virtual float GetDirectionalCutoffRadius () const = 0;

  virtual void SetDirectionalCutoffRadius (float radius) = 0;

  virtual void SetSpotLightFalloff (float inner, float outer) = 0;

  virtual void GetSpotLightFalloff (float& inner, float& outer) const = 0;

  virtual iCrossHalo* CreateCrossHalo (float intensity, float cross) = 0;
  virtual iNovaHalo* CreateNovaHalo (int seed, int num_spokes,
        float roundness) = 0;
  virtual iFlareHalo* CreateFlareHalo () = 0;

  virtual iBaseHalo* GetHalo () const = 0;

  virtual float GetBrightnessAtDistance (float d) const = 0;

  virtual csFlags& GetFlags () = 0;

  virtual void SetLightCallback (iLightCallback* cb) = 0;

  virtual void RemoveLightCallback (iLightCallback* cb) = 0;

  virtual int GetLightCallbackCount () const = 0;
  
  virtual iLightCallback* GetLightCallback (int idx) const = 0;

  virtual uint32 GetLightNumber () const = 0;

  virtual void AddAffectedLightingInfo (iLightingInfo* li) = 0; 

  virtual void RemoveAffectedLightingInfo (iLightingInfo* li) = 0; 

  virtual void Setup () = 0;

  virtual iShaderVariableContext* GetSVContext() = 0;
};

struct iLightList : public virtual iBase
{
  SCF_INTERFACE(iLightList,2,0,0);
  virtual int GetCount () const = 0;

  virtual iLight *Get (int n) const = 0;

  virtual int Add (iLight *obj) = 0;

  virtual bool Remove (iLight *obj) = 0;

  virtual bool Remove (int n) = 0;

  virtual void RemoveAll () = 0;

  virtual int Find (iLight *obj) const = 0;

  virtual iLight *FindByName (const char *Name) const = 0;

  virtual iLight *FindByID (const char* id) const = 0;
};

struct iLightingProcessData : public virtual iBase
{
  SCF_INTERFACE (iLightingProcessData, 1, 0, 0);

  virtual void FinalizeLighting () = 0;
};

struct iLightingProcessInfo : public iFrustumViewUserdata
{
  SCF_INTERFACE(iLightingProcessInfo,2,0,0);
  virtual iLight* GetLight () const = 0;

  virtual bool IsDynamic () const = 0;

  virtual void SetColor (const csColor& col) = 0;

  virtual const csColor& GetColor () const = 0;

  virtual void AttachUserdata (iLightingProcessData* userdata) = 0;

  virtual csPtr<iLightingProcessData> QueryUserdata (scfInterfaceID id,
        int version) = 0;

  virtual void FinalizeLighting () = 0;
};

SCF_VERSION (iLightIterator, 0, 1, 0);

struct iLightIterator : public virtual iBase
{
  virtual bool HasNext () = 0;

  virtual iLight* Next () = 0;

  virtual iSector* GetLastSector () = 0;

  virtual void Reset () = 0;

};

#endif // __CS_IENGINE_LIGHT_H__

---