ilayer.h

Go to the documentation of this file.

/**********************************************************************
 *<
    FILE: ILayer.h

    DESCRIPTION: Declaration of the ILayer interface

    CREATED BY: Peter Sauerbrei

    HISTORY: Created 19 October 1998

 *> Copyright (c) 1998-99, All Rights Reserved.
 **********************************************************************/
#pragma once
#include "maxtypes.h"
#include "ref.h"
// forward declarations
class View;
class Point3;
class INode;

#define NODE_LAYER_REF      6

class LayerProperty : public ReferenceTarget
{
private: 
    int m_id;
    MSTR m_name;

public:
    LayerProperty() : m_id(-1), m_name("") {}
    LayerProperty(const MSTR & name, int id) : m_id(id), m_name(name) {}
    virtual ~LayerProperty() {}

    // child methods
    virtual void SetProperty(const int d) = 0;
    virtual void SetProperty(const float d) = 0;
    virtual void SetProperty(const Point3 & d) = 0;
    virtual void SetProperty(const MSTR & d) = 0;
    virtual void SetProperty(void * d) = 0;
    virtual bool GetProperty(int & i) const = 0;
    virtual bool GetProperty(float & f) const = 0;
    virtual bool GetProperty(Point3 & p) const = 0;
    virtual bool GetProperty(MSTR & n) const = 0;
    virtual bool GetProperty(void * v) const = 0;

    // local methods
    int GetID() const { return m_id; }
    void SetID(int id) { m_id = id; }
    MSTR GetName() const { return m_name; }
    void SetName(const MSTR & name) { m_name = name; }
};

class ILayer : public ReferenceTarget
{
public:
    static const SClass_ID kLayerSuperClassID;

    // from Animatable
    SClass_ID SuperClassID() { return kLayerSuperClassID; }

    // from ILayerRecord
    virtual bool AddToLayer(INode * rtarg) = 0;
    virtual bool DeleteFromLayer(INode * rtarg) = 0;
    virtual void SetName(const MSTR & name) = 0;
    virtual MSTR GetName() const = 0;       // user must delete the string
    virtual void SetWireColor(DWORD newcol) = 0;
    virtual DWORD GetWireColor() const = 0;
    virtual void Hide(bool onOff) = 0;
    virtual bool IsHidden() const = 0;
    virtual void Freeze(bool onOff) = 0;
    virtual bool IsFrozen() const = 0;
    virtual void SetRenderable(bool onOff) = 0;
    virtual bool Renderable() const = 0;
// mjm - 06.12.00 - begin
    virtual void SetPrimaryVisibility(bool onOff) = 0;
    virtual bool GetPrimaryVisibility() const = 0;
    virtual void SetSecondaryVisibility(bool onOff) = 0;
    virtual bool GetSecondaryVisibility() const = 0;
// mjm - end
    virtual void XRayMtl(bool onOff) = 0;
    virtual bool HasXRayMtl() const = 0;
    virtual void IgnoreExtents(bool onOff) = 0;
    virtual bool GetIgnoreExtents() const = 0;
    virtual void BoxMode(bool onOff) = 0;
    virtual bool GetBoxMode() const = 0;
    virtual void AllEdges(bool onOff) = 0;
    virtual bool GetAllEdges() const = 0;
    virtual void VertTicks(bool onOff) = 0;
    virtual bool GetVertTicks() const = 0;
    virtual void BackCull(bool onOff) = 0;
    virtual bool GetBackCull() const = 0;
    virtual void SetCVertMode(bool onOff) = 0;
    virtual bool GetCVertMode() const = 0;
    virtual void SetShadeCVerts(bool onOff) = 0;
    virtual bool GetShadeCVerts() const = 0;
    virtual void SetCastShadows(bool onOff) = 0;
    virtual bool CastShadows() const = 0;
    virtual void SetRcvShadows(bool onOff) = 0;
    virtual bool RcvShadows() const = 0;
// mjm - 06.12.00 - begin
    virtual void SetApplyAtmospherics(bool onOff) = 0;
    virtual bool ApplyAtmospherics() const = 0;
// mjm - end
    virtual void SetMotBlur(int kind) = 0;
    virtual int MotBlur() const = 0;
    virtual int GetRenderFlags() const = 0;
    virtual void SetRenderFlags(int flags) = 0;
    virtual int GetDisplayFlags() const = 0;
    virtual int AddProperty(LayerProperty & lprop) = 0;
    virtual int SetProperty(LayerProperty & lprop) = 0;
    virtual int GetProperty(LayerProperty & lprop) const = 0;
    virtual bool Used(void) const = 0;
    virtual bool GetFlag(int mask) const = 0;
    virtual bool GetFlag2(int mask) const = 0;
    virtual void UpdateSelectionSet(void) = 0;
    virtual int GetRenderFlags(int oldlimits) const = 0;
    virtual void SetInheritVisibility(bool onOff) = 0;
    virtual bool GetInheritVisibility() const = 0;
    virtual void Trajectory(bool onOff, bool temp = false) = 0;
    virtual bool GetTrajectory() const = 0;
    virtual void SetDisplayByLayer(BOOL onOff, INode *) = 0;
    virtual void SetRenderByLayer(BOOL onOff, INode *) = 0;
    virtual void SetMotionByLayer(BOOL onOff, INode *) = 0;
    virtual BOOL GetDisplayByLayer(INode *) const = 0;
    virtual BOOL GetRenderByLayer(INode *) const = 0;
    virtual BOOL GetMotionByLayer(INode *) const = 0;
    virtual void SelectObjects(void) = 0;
    virtual void SetVisibility(TimeValue t, float vis) = 0;
    virtual float GetVisibility(TimeValue t,Interval *valid=NULL) const = 0;
    virtual float GetVisibility(TimeValue t,View & view, Interval *valid=NULL) const = 0;
    virtual float GetImageBlurMultiplier(TimeValue t) const = 0;
    virtual void  SetImageBlurMultiplier(TimeValue t, float m) = 0;
    virtual bool GetMotBlurOnOff(TimeValue t) const = 0;
    virtual void  SetMotBlurOnOff(TimeValue t, bool m) = 0;
    virtual bool IsHiddenByVisControl() = 0;
    virtual float GetLocalVisibility(TimeValue t,Interval *valid) const = 0;

    //New methods in R4
    virtual void SetShowFrozenWithMtl( bool onOff) = 0;
    virtual int ShowFrozenWithMtl() const = 0;

    virtual void SetRenderOccluded(bool onOff) = 0;
    virtual int GetRenderOccluded() const = 0;

    // promoted to public method 030530  --prs.
    virtual bool HasObjects() const = 0;
};