DM_Drawable.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:
 *
 * COMMENTS:
 *
 */

#ifndef DM_Drawable_H
#define DM_Drawable_H

#include "DM_API.h"
#include <GU/GU_Detail.h>
#include <GU/GU_DetailHandle.h>
#include <UT/UT_UniquePtr.h>
#include <GUI/GUI_DetailLook.h>
#include <GR/GR_Material.h>

class UT_Color;
class DM_SceneManager;
class DM_Viewport;
class GUI_DetailLook;
class SOP_Node;
class DM_DrawableMonitor;

class DM_API DM_Drawable
{
public:
    DM_Drawable(DM_SceneManager &scene_manager, const char *name, const char *label, GU_Detail* detail=nullptr);
    ~DM_Drawable();

    void enable(bool flag);
    bool enabled() const;
    void show(bool flag);
    bool visible() const;

    // restrict visibility of this look to certain viewports (one or more)
    void setVisibleInViewport(const DM_Viewport &vport);
    void setVisibleInAllViewports();
    bool isVisibleInViewport(const DM_Viewport &vport) const;

    UT_Matrix4D transform() const;
    void setTransform(UT_DMatrix4 const & xform);

    void setXray(bool value);
    bool isXray() const;
    void setShowMaterials(bool value);
    bool isShowMaterials() const;
    void setWireframeMode(bool value);
    bool wireframeMode() const;
    void setWireframeColor(UT_Color const& color);
    UT_Color wireframeColor() const;
    void setUseWireframeColor(bool value);
    bool useWireframeColor() const;
    bool isCastShadows() const;
    void setCastShadows(bool value);
    bool isDrawOutline() const;
    void setDrawOutline(bool value);
    void setOutlineColor(UT_Vector4F const& color);
    bool isSeparateOutline() const;
    void setSeparateOutline(bool value);
    UT_Vector4F getOutlineColor() const;
    bool isOutlineOnly() const;
    void setOutlineOnly(bool value);
    void setMaterial(GR_MaterialPtr material);

    void setIsControl(bool is_control);
    bool isControl() const; 

    void setSnappable(bool snappable);
    bool isSnappable() const; 

    const char* name() const;   
    const char* label() const;   
    void setLabel(char const * label);
    GU_Detail* detail();
    GU_Detail const* detail() const;
    void acquireDetail( GU_DetailHandle const & gdh );

    GU_ConstDetailHandle detailHandle() const;

    void setSopNode(SOP_Node* node);
    SOP_Node* sopNode() const;

    GUI_DetailLook *look() const;

    void unregister();

private:
    DM_SceneManager&            mySceneManager;
    GU_DetailHandle             myDetailHandle;
    GUI_DetailLookPtr           myDetailLook;
    int                         mySopNodeId = -1;
    UT_StringHolder             myLabel;
    UT_WeakPtr<DM_DrawableMonitor> myDrawableMonitor;
};

#endif // DM_Drawable_H