HOM_Bookmark.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.
 *
 * COMMENTS: HOM Interface for a CH_Bookmark
 */

#ifndef __HOM_Bookmark_h__
#define __HOM_Bookmark_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Module.h"
#include <string>
#include <vector>

class CH_Bookmark;
class HOM_Color;

SWIGOUT(%rename(Bookmark) HOM_Bookmark;)

class HOM_API HOM_Bookmark
{
public:
    HOM_Bookmark()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_Bookmark(const HOM_Bookmark &)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_Bookmark()
    { HOM_DESTRUCT_OBJECT(this) }

    virtual std::string __repr__() = 0;

    virtual std::string name() = 0;
    virtual void setName(const char *name) = 0;

    virtual int startFrame() = 0;
    virtual void setStartFrame(int start) = 0;

    virtual int endFrame() = 0;
    virtual void setEndFrame(int end) = 0;

    virtual std::string comment() = 0;
    virtual void setComment(const char *comment) = 0;

    virtual HOM_Color color() = 0;
    virtual void setColor(HOM_Color &color) = 0;

    virtual bool visible() = 0;
    virtual void setVisible(bool visible) = 0;

    virtual int64 sessionId() = 0;

    virtual bool isTemporary() = 0;
    virtual void setTemporary(bool temporary) = 0;

    virtual bool isEnabled() = 0;
    virtual void enable(bool enabled) = 0;

    virtual void setMetadata(
            const std::string &key,
            HOM_UTOptionAny value,
            HOM_EnumValue &type_hint = HOM_fieldType::NoSuchField)
            = 0;

    virtual HOM_UTOptionAny metadata(
            const std::string &key,
            HOM_UTOptionAny default_value = HOM_UTOptionAny())
            = 0;

    SWIGOUT(%ignore getBookmark;)
    virtual CH_Bookmark &getBookmark() = 0;
};

#endif