INodeMentalRayProperties.h

Go to the documentation of this file.

 /**********************************************************************
 
    FILE:           INodeMentalRayProperties.h

    DESCRIPTION:    Public interface for setting and getting a node's
                    mental ray properties.

    CREATED BY:     Daniel Levesque, Discreet

    HISTORY:        created 13 December 2004

 *> Copyright (c) 2004, All Rights Reserved.
 **********************************************************************/
#pragma once

#include "ifnpub.h"
#include "inode.h"

// forward declarations
class INode;

#define NODEMENTALRAYPROPERTIES_INTERFACE Interface_ID(0x1c763921, 0x4d542752)

//==============================================================================
// Class INodeMentalRayProperties
//
class INodeMentalRayProperties : public FPMixinInterface {

public:

    enum DisplacementMethod {
        kDisplacementMethod_Fine = 0,
        kDisplacementMethod_Fine_NoSmoothing = 1
    };

    enum CastModeFG {
        kCastModeFG_ObjColor = 0,
        kCastModeFG_Black = 1,
        kCastModeFG_Invisible =2
    };

    static INodeMentalRayProperties* Get_INodeMentalRayProperties(INode& node);

    virtual void CopyMentalRayPropertiesFrom(const INodeMentalRayProperties& source) = 0;

    virtual bool MRGetDisplacementUseGlobalSettings() const = 0;

    virtual void MRSetDisplacementUseGlobalSettings(bool useGlobal) = 0;

    virtual DisplacementMethod MRGetDisplacementMethod() const = 0;  

    virtual void MRSetDisplacementMethod(DisplacementMethod method) = 0;

    virtual bool MRGetIsViewDependentDisplacement() const = 0;

    virtual void MRSetIsViewDependentDisplacement(bool viewDependent) = 0;

    virtual float MRGetDisplacementEdgeLength() const = 0;

    virtual void MRSetDisplacementEdgeLength(float length) = 0;

    virtual float MRGetMaxDisplace() const = 0;

    virtual void MRSetMaxDisplace(float maxDisplace) = 0;

    virtual unsigned short MRGetDisplacementMaxLevel() const = 0;

    virtual void MRSetDisplacementMaxLevel(unsigned short maxLevel) = 0;

    virtual bool MRGetReceiveFGIllum() const = 0;

    virtual void MRSetReceiveFGIllum(bool onOff) = 0;

    virtual CastModeFG MRGetCastModeFGIllum() const = 0;  

    virtual void MRSetCastModeFGIllum(CastModeFG method) = 0;

    virtual bool MRGetExcludeGlobalIllum() const = 0;

    virtual void MRSetExcludeGlobalIllum(bool onOff) = 0;

    virtual bool MRGetExcludeCaustics() const = 0;

    virtual void MRSetExcludeCaustics(bool onOff) = 0;

private:

    // This version of the method is needed by the function publishing macros.
    void MRSetDisplacementMethod(int method);
    void MRSetCastModeFGIllum(int mode);

public:

    // Function publishing interface    
    enum PROPERTY_ACCESSOR_ID {
        GET_DISPLACEMENTUSEGLOBALSETTINGS,
        SET_DISPLACEMENTUSEGLOBALSETTINGS,
        GET_DISPLACEMENTMETHOD,
        SET_DISPLACEMENTMETHOD,
        GET_VIEWDEPENDENTDISPLACEMENT,
        SET_VIEWDEPENDENTDISPLACEMENT,
        GET_DISPLACEMENTEDGELENGTH,
        SET_DISPLACEMENTEDGELENGTH,
        GET_MAXDISPLACE,
        SET_MAXDISPLACE,
        GET_DISPLACEMENTMAXLEVEL,
        SET_DISPLACEMENTMAXLEVEL,
        GET_RECEIVEFGILLUM,
        SET_RECEIVEFGILLUM,
        GET_CASTMODEFGILLUM,
        SET_CASTMODEFGILLUM,
        GET_EXCLUDEGLOBALILLUM,
        SET_EXCLUDEGLOBALILLUM,
        GET_EXCLUDECAUSTICS,
        SET_EXCLUDECAUSTICS
    };

    #pragma warning(push)
    #pragma warning(disable:4244)
    BEGIN_FUNCTION_MAP
        // Property accessors
        PROP_FNS(GET_DISPLACEMENTUSEGLOBALSETTINGS, MRGetDisplacementUseGlobalSettings, SET_DISPLACEMENTUSEGLOBALSETTINGS, MRSetDisplacementUseGlobalSettings, TYPE_bool);
        PROP_FNS(GET_DISPLACEMENTMETHOD, MRGetDisplacementMethod, SET_DISPLACEMENTMETHOD, MRSetDisplacementMethod, TYPE_ENUM);
        PROP_FNS(GET_VIEWDEPENDENTDISPLACEMENT, MRGetIsViewDependentDisplacement, SET_VIEWDEPENDENTDISPLACEMENT, MRSetIsViewDependentDisplacement, TYPE_bool);
        PROP_FNS(GET_DISPLACEMENTEDGELENGTH, MRGetDisplacementEdgeLength, SET_DISPLACEMENTEDGELENGTH, MRSetDisplacementEdgeLength, TYPE_FLOAT);
        PROP_FNS(GET_MAXDISPLACE, MRGetMaxDisplace, SET_MAXDISPLACE, MRSetMaxDisplace, TYPE_WORLD);
        // The warning here is harmless. In the future MRSetDisplacementMaxLevel could take an int instead of an unsigned short.
        PROP_FNS(GET_DISPLACEMENTMAXLEVEL, MRGetDisplacementMaxLevel, SET_DISPLACEMENTMAXLEVEL, MRSetDisplacementMaxLevel, TYPE_INT);
        PROP_FNS(GET_RECEIVEFGILLUM, MRGetReceiveFGIllum, SET_RECEIVEFGILLUM, MRSetReceiveFGIllum, TYPE_bool);
        PROP_FNS(GET_CASTMODEFGILLUM, MRGetCastModeFGIllum, SET_CASTMODEFGILLUM, MRSetCastModeFGIllum, TYPE_ENUM);
        PROP_FNS(GET_EXCLUDEGLOBALILLUM, MRGetExcludeGlobalIllum, SET_EXCLUDEGLOBALILLUM, MRSetExcludeGlobalIllum, TYPE_bool);
        PROP_FNS(GET_EXCLUDECAUSTICS, MRGetExcludeCaustics, SET_EXCLUDECAUSTICS, MRSetExcludeCaustics, TYPE_bool);
    END_FUNCTION_MAP
    #pragma warning(pop)
};

inline void INodeMentalRayProperties::MRSetDisplacementMethod(int method) {

    return MRSetDisplacementMethod(static_cast<DisplacementMethod>(method));
}

inline void INodeMentalRayProperties::MRSetCastModeFGIllum(int mode) {
    MRSetCastModeFGIllum(static_cast<CastModeFG>(mode));
}

inline INodeMentalRayProperties* INodeMentalRayProperties::Get_INodeMentalRayProperties(INode& node) {

    return static_cast<INodeMentalRayProperties*>(node.GetInterface(NODEMENTALRAYPROPERTIES_INTERFACE));
}