lslights.h

Go to the documentation of this file.

//*****************************************************************************/
// Copyright (c) 1997,1998 Discreet Logic, Inc.
//
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Discreet Logic and
// are protected by Federal copyright law. They may not be disclosed
// to third parties or copied or duplicated in any form, in whole or
// in part, without the prior written consent of Discreet Logic.
//*****************************************************************************/

#pragma once

/*==============================================================================
 * EXTERNAL DECLARATIONS
 *============================================================================*/
#include "maxtypes.h"
#include "genlight.h"
#include "custattrib.h"
/*==============================================================================
 * FORWARD DECLARATIONS
 *============================================================================*/
class ToneOperator;
class ShadowType;
class Interval;


#define LIGHTSCAPE_LIGHT_CLASS Class_ID(0x30331006, 0x2454bd3)

#define LS_POINT_LIGHT_ID Class_ID(0x32375fcc, 0xb025cf0)

#define LS_LINEAR_LIGHT_ID Class_ID(0x78207401, 0x357f1d58)

#define LS_AREA_LIGHT_ID Class_ID(0x36507d92, 0x105a1a47)

#define LS_DISC_LIGHT_ID Class_ID(0x5bcc6d42, 0xc4f430e)

#define LS_SPHERE_LIGHT_ID Class_ID(0x7ca93582, 0x1abb6b32)

#define LS_CYLINDER_LIGHT_ID Class_ID(0x46f634e3, 0xa327aaf)

#define LS_POINT_LIGHT_TARGET_ID Class_ID(0x658d4f97, 0x72cd4259)

#define LS_LINEAR_LIGHT_TARGET_ID Class_ID(0x45076885, 0x40791449)

#define LS_AREA_LIGHT_TARGET_ID Class_ID(0x71794f9d, 0x70ae52f2)

#define LS_DISC_LIGHT_TARGET_ID Class_ID(0x38732348, 0x201758b3)

#define LS_SPHERE_LIGHT_TARGET_ID Class_ID(0x33fc7ae9, 0x54433dc5)

#define LS_CYLINDER_LIGHT_TARGET_ID Class_ID(0x7c8b5b10, 0x4bd33e86)

#define LS_AREALIGHTCUSTATTRIB_CLASS_ID Class_ID(0x554c5e06, 0x325037bc)


#define LS_AREALIGHTCUSTATTRIB_INTERFACE_ID Interface_ID(0x46aa0b9f, 0x64866ff3)

#define LIGHTSCAPE_LIGHT_INTENSITY_MIN 0.0f
#define LIGHTSCAPE_LIGHT_INTENSITY_MAX 1.0e7f

/*==============================================================================
 * CLASS LightscapeLight
 *============================================================================*/
#pragma warning(push)
#pragma warning(disable:4239)



class LightscapeLight : public GenLight {

public: 

    /*----- constants -----*/

    /*----- types and enumerations ----*/

    enum LightTypes {
      TYPE_BASE                  = 532,
      TARGET_POINT_TYPE          = TYPE_BASE + 0,  
      POINT_TYPE                 = TYPE_BASE + 1,  
      TARGET_LINEAR_TYPE         = TYPE_BASE + 2,  
      LINEAR_TYPE                = TYPE_BASE + 3,  
      TARGET_AREA_TYPE           = TYPE_BASE + 4,  
      AREA_TYPE                  = TYPE_BASE + 5,  
      TARGET_DISC_TYPE           = TYPE_BASE + 6,  
      DISC_TYPE                  = TYPE_BASE + 7,  
      TARGET_SPHERE_TYPE         = TYPE_BASE + 8,  
      SPHERE_TYPE                = TYPE_BASE + 9,  
      TARGET_CYLINDER_TYPE       = TYPE_BASE + 10, 
      CYLINDER_TYPE              = TYPE_BASE + 11, 
      LAST_TYPE                  = CYLINDER_TYPE   
    };

    enum DistTypes {
      ISOTROPIC_DIST             = 0,           
      SPOTLIGHT_DIST             = 1,           
      DIFFUSE_DIST               = 2,           
      WEB_DIST                   = 3,           
      LAST_DIST                  = WEB_DIST     
    };

    enum ReferenceIDs {
      REF_PARAMS                 = 0,
      REF_SHADOW_PARAMS          = 1,
      REF_SPOT_PARAMS            = 2,
      REF_WEB_PARAMS             = 3,
      REF_SHADOWGEN              = 4,
      REF_EXT_PARAMS             = 5,
      LAST_REF                   = REF_EXT_PARAMS
    };

    enum ParameterBlockID {
      PB_GENERAL                 = 0,
      PB_SHADOW                  = 1,
      PB_SPOT                    = 2,
      PB_WEB                     = 3,
      PB_EXT                     = 4,
      LAST_PB                    = PB_EXT
    };

    enum ParameterIDs {
      PB_DIST_TYPE               = 1,
      PB_USE_LIGHT               = 2,
      PB_CAST_SHADOWS            = 3,
      PB_LIGHT_COLOR             = 4,
      PB_FILTER_COLOR            = 5,
      PB_INTENSITY               = 6,
      PB_KELVIN                  = 8,
      PB_USE_KELVIN              = 10,
      PB_INTENSITY_AT            = 13,
      PB_INTENSITY_TYPE          = 14,
      PB_FLUX                    = 15,
      PB_ORIGINAL_INTENSITY      = 16,
      PB_ORIGINAL_FLUX           = 17,
      PB_USE_DIMMER               = 18,
      PB_DIMMER                       = 19,
      PB_COLORSHIFT_DIMMING       = 20,
      PB_USE_FARATTENUATION       = 21,
      PB_SHOW_FARATTENUATION_GIZMO = 22,
      PB_START_FARATTENUATION     = 23,
      PB_END_FARATTENUATION      = 24,
      LAST_GEN_PB                = PB_END_FARATTENUATION
    };

    enum ExtParamIDs {
      PB_CONTRAST                = 0,
      PB_DIFFSOFT                = 1,
      PB_PROJECTOR               = 2,
      PB_PROJECTOR_MAP           = 3,
      PB_AFFECT_DIFFUSE          = 4,
      PB_AFFECT_SPECULAR         = 5,
      PB_AMBIENT_ONLY            = 6,
      PB_TDIST                   = 7,
//      PB_LENGTH                       = 8,
//      PB_WIDTH                            = 9,  
//      PB_GARBAGE                      = 10,
//      WARNING:  DO NOT REDEFINE ABOVE IDs.  THIS MAY CAUSE A CRASH WHEN LOADING OLD
//                   FILES
//    Change made August 27, 2001 David Cunningham
//    for B24 of VIZ R4
        PB_LINELIGHT_LENGTH             = 11,
        PB_AREALIGHT_LENGTH             = 11,
        PB_AREALIGHT_WIDTH              = 12, 
        PB_DISCLIGHT_RADIUS             = 13,
        PB_SPHERELIGHT_RADIUS_OLD       = 14, // obsolete, use PB_SPHERELIGHT_RADIUS instead
        PB_SPHERELIGHT_RADIUS           = PB_DISCLIGHT_RADIUS,
        PB_CYLINDERLIGHT_RADIUS_OLD     = 15, // obsolete, use PB_CYLINDERLIGHT_RADIUS instead
        PB_CYLINDERLIGHT_RADIUS         = PB_DISCLIGHT_RADIUS,
        PB_CYLINDERLIGHT_LENGTH_OLD     = 16, // obsolete, use PB_CYLINDERLIGHT_LENGTH instead
        PB_CYLINDERLIGHT_LENGTH         = PB_LINELIGHT_LENGTH,
      LAST_EXT_PB                = PB_CYLINDERLIGHT_LENGTH_OLD
    };

    enum ShadowIDs {
      PB_ATMOS_SHAD              = 0,
      PB_ATMOS_OPACITY           = 1,
      PB_ATMOS_COLAMT            = 2,
      PB_SHADMULT                = 3,
      PB_SHAD_COLMAP             = 4,
      PB_SHADCOLOR               = 5,
      PB_LIGHT_AFFECTS_SHADOW    = 6,
      PB_USE_GLOBAL_PARAMS       = 7,
      PB_SHAD_PROJ_MAP           = 8,
      LAST_SHAD_PB               = PB_SHAD_PROJ_MAP
    };

    enum SpotlightIDs {
      PB_BEAM_ANGLE              = 0,
      PB_FIELD_ANGLE             = 1,
      PB_CONE_DISPLAY            = 2,
      LAST_SPOT_PB               = PB_CONE_DISPLAY
    };

    enum DistributionIDs {
      PB_WEB_FILE_NAME           = 0,
      PB_WEB_ROTATE_X            = 1,
      PB_WEB_ROTATE_Y            = 2,
      PB_WEB_ROTATE_Z            = 3,
      LAST_WEB_PB               = PB_WEB_ROTATE_Z
    };

    enum IntensityType {
      LUMENS                     = 0,
      CANDELAS                   = 1,
      LUX_AT                     =2,
    };

    enum MaxShadowType {
      NO_SHADOW_GENERATOR        = -1,
      BITMAP_SHADOWS             = 0,
      RAYTRACE_SHADOWS           = 1,
      OTHER_SHADOWS              = 0xffff
    };

    /*----- classes -----*/

    class AreaLightCustAttrib;

    /*----- static member functions -----*/


    static AreaLightCustAttrib* GetAreaLightCustAttrib(
      CustAttrib* attrib
    );

    /*----- member functions -----*/



    virtual void SetType( int type ) = 0;

    virtual void SetType( const MCHAR* name ) = 0;

    virtual int Type( ) = 0;

    virtual const MCHAR* TypeName( ) = 0;



    virtual void SetDistribution( DistTypes dist ) = 0;

    virtual DistTypes GetDistribution( ) const = 0;



    virtual void SetIntensityAt( float f ) = 0;

    virtual float GetIntensityAt( ) = 0;



    virtual void SetIntensityType( IntensityType t ) = 0;

    virtual IntensityType GetIntensityType( ) = 0;



    virtual void SetFlux(
      TimeValue t,
      float     flux
    ) = 0;

    virtual float GetFlux(
      TimeValue t,
      Interval &valid = Interval( 0,0 )
    ) const = 0;



    virtual void SetRGBFilter(
      TimeValue t,
      Point3& rgb
    ) = 0;

    virtual Point3 GetRGBFilter(
      TimeValue t,
      Interval &valid = Interval( 0,0 )
    ) = 0;

    virtual void SetHSVFilter(
      TimeValue t,
      Point3& hsv
    ) = 0;

    virtual Point3 GetHSVFilter(
      TimeValue t,
      Interval &valid = Interval( 0,0 )
    ) = 0;




    virtual ShadowType* ActiveShadowType( ) = 0;

    virtual ShadowType* GetShadowGenerator( ) = 0;

    virtual const MCHAR* GetShadowGeneratorName( ) = 0;

    virtual void SetShadowGenerator( ShadowType* s ) = 0;

    virtual void SetShadowGenerator( const MCHAR* name ) = 0;



    virtual void SetUseShadowColorMap(
      TimeValue t,
      int onOff
    ) = 0;

    virtual int GetUseShadowColorMap( TimeValue t ) = 0;


    virtual void SetInclude( BOOL onOff ) = 0;


    virtual void UpdateTargDistance(
      TimeValue t,
      INode* inode
    ) = 0;



    virtual BOOL SetKelvinControl( Control *kelvin ) = 0;

    virtual BOOL SetFilterControl( Control *filter ) = 0;

    virtual Control* GetKelvinControl( ) = 0;

    virtual Control* GetFilterControl( ) = 0;



    virtual float GetKelvin(
      TimeValue t,
      Interval& v = Interval(0,0)
    ) = 0;

    virtual void SetKelvin(
      TimeValue t,
      float kelvin
    ) = 0;



    virtual BOOL GetUseKelvin( ) = 0;

    virtual void SetUseKelvin( BOOL useKelvin ) = 0;



    virtual MaxSDK::AssetManagement::AssetUser GetWebFile( ) const = 0;

    virtual const MCHAR* GetFullWebFileName( ) const = 0;

    virtual void SetWebFile( const MaxSDK::AssetManagement::AssetUser& file ) = 0;



    virtual float GetWebRotateX( ) const = 0;

    virtual void SetWebRotateX( float degrees ) = 0;

    virtual float GetWebRotateY( ) const = 0;

    virtual void SetWebRotateY( float degrees ) = 0;

    virtual float GetWebRotateZ( ) const = 0;

    virtual void SetWebRotateZ( float degrees ) = 0;



    virtual float GetDimmerValue(TimeValue t, Interval &valid = Interval( 0,0 )) const = 0;

    virtual void SetDimmerValue(TimeValue t, float dimmer) = 0;



    virtual BOOL GetUseMultiplier() const = 0;

    virtual void SetUseMultiplier(BOOL on) = 0;



    virtual BOOL IsColorShiftEnabled() const = 0;


    virtual void EnableColorShift(BOOL on) = 0;



    virtual float GetResultingIntensity(TimeValue t, Interval &valid = Interval( 0,0 )) const = 0;

    virtual float GetResultingFlux(TimeValue t, Interval &valid = Interval( 0,0 )) const = 0;


    virtual Point3 GetCenter( ) const = 0;



    virtual float GetRadius(TimeValue t, Interval &valid = Interval(0,0)) const = 0;


    virtual void SetRadius(TimeValue t, float radius) = 0;



    virtual float GetLength(TimeValue t, Interval &valid = Interval(0,0)) const = 0;


    virtual void SetLength(TimeValue t, float length) = 0;



    virtual float GetWidth(TimeValue t, Interval &valid = Interval(0,0)) const = 0;


    virtual void SetWidth(TimeValue t, float width) = 0;




    virtual void SetShape(
      int            count,
      const Point3*  pointsIn
    ) = 0;

    virtual int GetShape(
      Point3*  pointsOut,
      int      bufSize
    ) const = 0;



    virtual float GetOriginalFlux( ) const = 0;

    virtual void SetOriginalFlux( float flux ) = 0;



    virtual float GetOriginalIntensity( ) const = 0;

    virtual void SetOriginalIntensity( float candelas ) = 0;
};

#pragma warning(pop)


class LightscapeLight::AreaLightCustAttrib : public BaseInterface {

public:

    enum {
        kDefaultSamples_Area         = 32,                          
        kDefaultSamples_Linear   = kDefaultSamples_Area,    
        kDefaultSamples_Cylinder = kDefaultSamples_Area,    
        kDefaultSamples_Sphere   = kDefaultSamples_Area,    
        kDefaultSamples_Disc     = kDefaultSamples_Area,    
        kDefaultSamples_Point    = 0                            
    };

    static const BOOL kDefault_EnableAreaLight = TRUE;

    static const BOOL kDefault_EnableLightShapeRendering = FALSE;


    virtual bool AreaLightComputationEnabled(TimeValue t, Interval* valid = NULL) const = 0;


    virtual BOOL IsLightShapeRenderingEnabled(TimeValue t, Interval* valid = NULL) const = 0;


    virtual void LightShapeRenderingEnabled(TimeValue t, BOOL on) = 0;



    virtual int GetNumSamples(TimeValue t, Interval* valid = NULL) const = 0;

    virtual void SetNumSamples(TimeValue t, int numSamples) = 0;

    // -- from BaseInterface
    virtual Interface_ID GetID() { return LS_AREALIGHTCUSTATTRIB_INTERFACE_ID; }   
};


inline LightscapeLight::AreaLightCustAttrib*
LightscapeLight::GetAreaLightCustAttrib(
    CustAttrib* attrib
)
{
    return attrib == NULL ? NULL
        : static_cast<LightscapeLight::AreaLightCustAttrib*>(
            attrib->GetInterface(LS_AREALIGHTCUSTATTRIB_INTERFACE_ID));
}