#include <CH_Bookmark.h>

Public Member Functions
	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

void	setName (const UT_StringHolder &name)

const UT_StringHolder &	getComment () const

void	setComment (const UT_StringHolder &comment)

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

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

exint	getEndFrame () const

void	setEndFrame (exint frame)

int	getIndex () const

UT_Color	getColor () const

void	setColor (const UT_Color &color)

bool	isVisible () const

void	setVisible (bool visible)

int64	sessionId () const

void	setTemporary (bool temporary)

bool	isTemporary () const

void	enable ()

void	disable ()

bool	isEnabled () const

bool	save (UT_JSONWriter &w) const

bool	load (UT_JSONParser &p)

bool	loadOTIOFormat (UT_JSONParser &p)

UT_Options &	getMetadata ()

void	setMetadata (const UT_Options &options)

void	updateMetadata (const UT_Options &other)


fpreal	getStartTime () const

void	setStartTime (fpreal t)


fpreal	getEndTime () const

void	setEndTime (fpreal t)

Detailed Description

Definition at line 22 of file CH_Bookmark.h.

Constructor & Destructor Documentation

CH_Bookmark::CH_Bookmark	(	const UT_StringHolder &	name,
		exint	start_frame,
		exint	end_frame,
		const UT_Color &	color,
		bool	temporary = `false`
	)

CH_Bookmark::~CH_Bookmark ( )

CH_Bookmark::CH_Bookmark ( const CH_Bookmark & other )

CH_Bookmark::CH_Bookmark ( CH_Bookmark && other )

default

Member Function Documentation

void CH_Bookmark::disable ( )

inline

Definition at line 91 of file CH_Bookmark.h.

void CH_Bookmark::enable ( )

inline

Definition at line 90 of file CH_Bookmark.h.

UT_Color CH_Bookmark::getColor ( ) const

inline

Definition at line 79 of file CH_Bookmark.h.

const UT_StringHolder& CH_Bookmark::getComment ( ) const

inline

Definition at line 40 of file CH_Bookmark.h.

exint CH_Bookmark::getEndFrame ( ) const

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.

fpreal CH_Bookmark::getEndTime ( ) const

inline

Accessors for the end time. When working with frames, get/setEndFrame should be used instead.

Definition at line 53 of file CH_Bookmark.h.

int CH_Bookmark::getIndex ( ) const

UT_Options& CH_Bookmark::getMetadata ( )

inline

Definition at line 99 of file CH_Bookmark.h.

const UT_StringHolder& CH_Bookmark::getName ( ) const

inline

Definition at line 37 of file CH_Bookmark.h.

exint CH_Bookmark::getStartFrame ( ) const

Getter for the rounded start frame of the range.

fpreal CH_Bookmark::getStartTime ( ) const

inline

Accessors for the start time. When working with frames, get/setStartFrame should be used instead.

Definition at line 46 of file CH_Bookmark.h.

bool CH_Bookmark::isEnabled ( ) const

inline

Definition at line 93 of file CH_Bookmark.h.

bool CH_Bookmark::isTemporary ( ) const

inline

Definition at line 88 of file CH_Bookmark.h.

bool CH_Bookmark::isVisible ( ) const

inline

Definition at line 82 of file CH_Bookmark.h.

bool CH_Bookmark::load ( UT_JSONParser & p )

bool CH_Bookmark::loadOTIOFormat ( UT_JSONParser & p )

CH_Bookmark& CH_Bookmark::operator= ( const CH_Bookmark & other )

CH_Bookmark& CH_Bookmark::operator= ( CH_Bookmark && other )

default

bool CH_Bookmark::save ( UT_JSONWriter & w ) const

int64 CH_Bookmark::sessionId ( ) const

inline

Definition at line 85 of file CH_Bookmark.h.

void CH_Bookmark::setColor ( const UT_Color & color )

inline

Definition at line 80 of file CH_Bookmark.h.

void CH_Bookmark::setComment ( const UT_StringHolder & comment )

inline

Definition at line 41 of file CH_Bookmark.h.

void CH_Bookmark::setEndFrame ( exint frame )

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 CH_Bookmark::setEndTime ( fpreal t )

inline

Accessors for the end time. When working with frames, get/setEndFrame should be used instead.

Definition at line 54 of file CH_Bookmark.h.

void CH_Bookmark::setMetadata ( const UT_Options & options )

inline

Definition at line 100 of file CH_Bookmark.h.

void CH_Bookmark::setName ( const UT_StringHolder & name )

inline

Definition at line 38 of file CH_Bookmark.h.

void CH_Bookmark::setStartFrame ( exint frame )

Setter for the rounded start frame of the range.

void CH_Bookmark::setStartTime ( fpreal t )

inline

Accessors for the start time. When working with frames, get/setStartFrame should be used instead.

Definition at line 47 of file CH_Bookmark.h.

void CH_Bookmark::setTemporary ( bool temporary )

inline

Definition at line 87 of file CH_Bookmark.h.

void CH_Bookmark::setVisible ( bool visible )

inline

Definition at line 83 of file CH_Bookmark.h.

void CH_Bookmark::updateMetadata ( const UT_Options & other )

inline

Definition at line 101 of file CH_Bookmark.h.

The documentation for this class was generated from the following file:

CH/CH_Bookmark.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation