CH_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.
 *
 * NAME:    CH Bookmark (C++)
 *
 * COMMENTS:    Bookmark which marks a frame range in the playback, allowing
 *              quickly jumping to relevant animation sequences 
 *
 */

#ifndef __CH_Bookmark_h__
#define __CH_Bookmark_h__

#include "CH_API.h"
#include "CH_Types.h"
#include <UT/UT_Color.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_Options.h>

class CH_API CH_Bookmark {
public:
    CH_Bookmark(const UT_StringHolder &name,
                exint start_frame,
                exint end_frame,
                const UT_Color &color,
                bool temporary = false);
    ~CH_Bookmark();

    CH_Bookmark(const CH_Bookmark &other);
    CH_Bookmark(CH_Bookmark &&other) = default;

    CH_Bookmark &operator=(const CH_Bookmark &other);
    CH_Bookmark &operator=(CH_Bookmark &&other) = default;

    const UT_StringHolder &getName() const { return myName; }
    void setName(const UT_StringHolder &name) { myName = name; }

    const UT_StringHolder &getComment() const { return myComment; }
    void setComment(const UT_StringHolder &comment) { myComment = comment; }

    /// @{
    /// Accessors for the start time.
    /// When working with frames, get/setStartFrame should be used instead.
    fpreal getStartTime() const { return myStart; }
    void   setStartTime(fpreal t) { myStart = t; }
    /// @}

    /// @{
    /// Accessors for the end time.
    /// When working with frames, get/setEndFrame should be used instead.
    fpreal getEndTime() const { return myEnd; }
    void   setEndTime(fpreal t) { myEnd = t; }
    /// @}

    /// Getter for the rounded start frame of the range.
    exint  getStartFrame() const;

    /// Setter for the rounded start frame of the range.
    void   setStartFrame(exint frame);

    /// Getter for the rounded end frame of the range.
    ///
    /// NOTE: Bookmark frame ranges include right up to the end of the
    ///       integer frame. This means that the end time to end frame
    ///       conversion does NOT add a frame.
    exint  getEndFrame() const;

    /// Setter for the rounded end frame of the range.
    ///
    /// NOTE: Bookmark frame ranges include right up to the end of the
    ///       integer frame. This means that the end time to end frame
    ///       conversion does NOT add a frame.
    void   setEndFrame(exint frame);

    int    getIndex() const;

    UT_Color getColor() const { return myColor; }
    void setColor(const UT_Color &color) { myColor = color; }

    bool isVisible() const { return myVisible; }
    void setVisible(bool visible) { myVisible = visible; }

    int64 sessionId() const { return myId; }

    void setTemporary(bool temporary) { myIsTemporary = temporary; }
    bool isTemporary() const { return myIsTemporary; }

    void enable() { myEnabled = true; }
    void disable() { myEnabled = false; }

    bool isEnabled() const { return myEnabled; }

    bool save(UT_JSONWriter &w) const;
    bool load(UT_JSONParser &p);
    bool loadOTIOFormat(UT_JSONParser &p);

    UT_Options &getMetadata() { return myMetadata; }
    void setMetadata(const UT_Options &options) { myMetadata = options; }
    void updateMetadata(const UT_Options &other) { myMetadata.merge(other); }

private:
    UT_StringHolder myName;
    UT_StringHolder myComment;
    UT_Color myColor;

    // Start and end are represented as time in the internal data for bookmarks.
    //
    // When converting to/from integer frames, the start frame is converted normally
    // while the end frame is one frame earlier than the time would normally
    // represent. This is because the entirety of the end frame is considered to be
    // in the bookmark.
    fpreal myStart;
    fpreal myEnd;

    // whether or not this bookmark is shown in the playbar, graph editor, and
    // dopesheet
    bool myVisible;

    // Whether or not this bookmark is temporary. Temporary bookmarks will not
    // be saved out unless the include_temporary flag is set.
    bool myIsTemporary;

    // Whether or not this bookmark is enabled. Disabled bookmarks are greyed
    // out on the timeline.
    bool myEnabled;

    // Ephemeral (per-session) id, used to help track bookmarks. This is more useful than
    // the index into the CH_Manager's bookmark list, as that often changes when bookmarks
    // are manipulated.
    int64 myId;

    UT_Options myMetadata;

    static SYS_AtomicInt64 theNextId;

    static int64 nextId();
};

#endif