MTimeSliderDrawPrimitive Class Reference

Introduced in 2023.0 More...

#include <MTimeSliderCustomDrawManager.h>

Public Member Functions
	MTimeSliderDrawPrimitive (MPrimitiveType, MTime startTime, MTime endTime, MColor color, double bottom=0, double height=-1, unsigned int priority=0)
	Constructor. More...
	MTimeSliderDrawPrimitive (const MTimeSliderDrawPrimitive &)
	Copy constructor. More...
MTimeSliderDrawPrimitive &	operator= (const MTimeSliderDrawPrimitive &)
	Copy from other primitive. More...
	~MTimeSliderDrawPrimitive ()
	Destructor.
void	setPriority (unsigned int p)
	Set the new priority for this primitive to control the order of drawing for overlapping primitives. More...
unsigned int	priority () const
	Get the priority for this primitive. More...
void	setDrawType (MPrimitiveType type)
	Change the draw type for this primitive. More...
MPrimitiveType	drawType () const
	Get the draw type. More...
void	setStartTime (const MTime &start)
	Change the start time for this primitive. More...
MTime	startTime () const
	Get the start time. More...
void	setEndTime (const MTime &end)
	Change the end time for this primitive. More...
MTime	endTime () const
	Get the end time. More...
void	setHeight (double height)
	Change the height for this primitive. More...
double	height () const
	Get the height. More...
void	setBottom (double bottom)
	Change the bottom for this primitive. More...
double	bottom () const
	Get the bottom. More...
void	setColor (const MColor &color)
	Change the color for this primitive. More...
MColor	color () const
	Get the color. More...
void	setLabel (const MString &label)
	Change the label for this primitive. More...
MString	label () const
	Get the label. More...
void	setTooltip (const MString &tooltip)
	Change the tooltip for this primitive. More...
MString	tooltip () const
	Get the tooltip. More...

Detailed Description

Introduced in 2023.0

2023.0:

Introduced in this version.

Constructor & Destructor Documentation

MTimeSliderDrawPrimitive	(	MPrimitiveType	pt,
		MTime	startTime,
		MTime	endTime,
		MColor	color,
		double	bottom = 0,
		double	height = -1,
		unsigned int	priority = 0
	)

Constructor.

Parameters

[in]	pt	primitiveType
[in]	startTime	Start time of the primitive drawing.
[in]	endTime	End time of the primitive drawing.
[in]	color	The color of the primitive.
[in]	bottom	The bottom is the vertical offset where it should start to draw the primitive.
[in]	height	The height of the primitive.
[in]	priority	The priority of the primitive, if multiple primitive overlap, priority will dictate which one is drawn on top.

MTimeSliderDrawPrimitive

(

const MTimeSliderDrawPrimitive &

dp

)

Copy constructor.

Parameters

[in]

dp

a drawPrimitive to copy from.

Member Function Documentation

MTimeSliderDrawPrimitive & operator=

(

const MTimeSliderDrawPrimitive &

other

)

Copy from other primitive.

Parameters

[in]

other

DrawPrimitive to copy from.

Returns

self.

void setPriority

(

unsigned int

p

)

Set the new priority for this primitive to control the order of drawing for overlapping primitives.

Parameters

[in]

p

The new priority for this primitive.

unsigned int priority

(

)

const

Get the priority for this primitive.

Returns

The priority for this primitive.

void setDrawType

(

MPrimitiveType

type

)

Change the draw type for this primitive.

Parameters

[in]

type

The new primitive type.

MTimeSliderDrawPrimitive::MPrimitiveType drawType

(

)

const

Get the draw type.

Returns

The draw type for this primitive.

void setStartTime

(

const MTime &

start

)

Change the start time for this primitive.

Parameters

[in]

start

The new primitive start.

MTime startTime

(

)

const

Get the start time.

Returns

the start time for this primitive.

void setEndTime

(

const MTime &

end

)

Change the end time for this primitive.

Parameters

[in]

end

The new primitive end time.

MTime endTime

(

)

const

Get the end time.

Returns

The end time for this primitive.

void setHeight

(

double

height

)

Change the height for this primitive.

Parameters

[in]

height

The new primitive height.

double height

(

)

const

Get the height.

Returns

The height for this primitive.

void setBottom

(

double

bottom

)

Change the bottom for this primitive.

Parameters

[in]

bottom

The new primitive bottom.

double bottom

(

)

const

Get the bottom.

Returns

The bottom for this primitive.

void setColor

(

const MColor &

color

)

Change the color for this primitive.

Parameters

[in]

color

The new primitive color.

MColor color

(

)

const

Get the color.

Returns

The color for this primitive.

void setLabel

(

const MString &

label

)

Change the label for this primitive.

Parameters

[in]

label

The new primitive label.

MString label

(

)

const

Get the label.

Returns

The label for this primitive.

void setTooltip

(

const MString &

tooltip

)

Change the tooltip for this primitive.

Parameters

[in]

tooltip

The new primitive tooltip.

MString tooltip

(

)

const

Get the tooltip.

Returns

The tooltip for this primitive.

---

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

• MTimeSliderCustomDrawManager.h
• MTimeSliderCustomDrawManager.cpp