#include <c4d_gui.h>

Detailed Description

A class that can be used to create custom GUI components.
There are already dozens of predefined buttons in the GUI easy available. But if one wants to make his own button, one needs to use the GeUserArea class.
Every user area has a specified drawing area and several commands for drawing lines or text. So it is possible to developer whatever needed, either a 3D trackball or a tree like object manager.

The message sequence when the user area is created:

Init() (only once)
GetMinSize()
Sized()
InitValues()
DrawMsg()
The message sequence if the user area is scaled:

Sized()
DrawMsg()
Does not require special allocation, but must be attached to a dialog with GeDialog::AttachUserArea().

Public Member Functions
Bool	OpenPopUpMenu (Int32 menuid, Int32 localx=-1, Int32 localy=-1, Int32 watchhotkey=0)

Protected Attributes
GeDialog *	dlg

Private Member Functions
	MAXON_DISALLOW_COPY_AND_ASSIGN (GeUserArea)

Private Attributes
Bool	owncu

CUserArea *	cu

Friends
class	GeDialog

Constructor/Destructor
	GeUserArea ()

virtual	~GeUserArea ()

Internal Representation
CUserArea *	Get ()

void	Set (CUserArea *t_cu)

Parent Dialog
GeDialog *	GetDialog ()

Override
virtual Bool	Init ()

virtual Bool	InitValues ()

virtual Bool	GetMinSize (Int32 &w, Int32 &h)

virtual void	Sized (Int32 w, Int32 h)

virtual OBSOLETE	Draw (Int32 x1, Int32 y1, Int32 x2, Int32 y2)

virtual void	DrawMsg (Int32 x1, Int32 y1, Int32 x2, Int32 y2, const BaseContainer &msg)

virtual Bool	InputEvent (const BaseContainer &msg)

virtual Bool	CoreMessage (Int32 id, const BaseContainer &msg)

virtual void	Timer (const BaseContainer &msg)

virtual Int32	Message (const BaseContainer &msg, BaseContainer &result)

Basic Functions
void	Redraw (Bool threaded=false)

Bool	SendParentMessage (const BaseContainer &msg)

GeData	SendParentMessageResult (const BaseContainer &msg)

Int32	GetId () const

Int32	GetWidth () const

Int32	GetHeight () const

Bool	IsEnabled () const

Bool	IsR2L () const

Bool	HasFocus () const

void	LayoutChanged ()

void	SetTimer (Int32 timer)

Input
Bool	GetInputState (Int32 askdevice, Int32 askchannel, BaseContainer &res) const

Bool	GetInputEvent (Int32 askdevice, BaseContainer &res) const

void	KillEvents ()

HOTKEYFLAGS	IsHotkeyDown (Int32 id) const

Draw
void	DrawSetPen (const Vector &color)

void	DrawSetPen (Int32 id)

Vector	DrawGetPenColor (Int32 id) const

void	DrawSetPen (const GeData &d)

void	DrawSetPenToParentBackgroundColor ()

GeData	GetParentBackgroundColor () const

void	DrawSetOpacity (Float opacity)

void	DrawSetTextCol (Int32 fg, Int32 bg)

void	DrawSetTextCol (const Vector &fg, Int32 bg)

void	DrawSetTextCol (Int32 fg, const Vector &bg)

void	DrawSetTextCol (const Vector &fg, const Vector &bg)

void	DrawSetTextCol (const GeData &fg, const GeData &bg)

Bool	GetColorRGB (Int32 colorid, Int32 &r, Int32 &g, Int32 &b) const

void	ActivateFading (Int32 milliseconds)

void	AdjustColor (Int32 colorid, Int32 highlightid, Float percent)

void	DrawLine (Int32 x1, Int32 y1, Int32 x2, Int32 y2, Float lineWidth=1.0, LINESTYLE lineStyle=LINESTYLE::NORMAL)

void	DrawFrame (Int32 x1, Int32 y1, Int32 x2, Int32 y2, Float lineWidth=1.0, LINESTYLE lineStyle=LINESTYLE::NORMAL)

void	DrawRectangle (Int32 x1, Int32 y1, Int32 x2, Int32 y2)

void	DrawBitmap (BaseBitmap *bmp, Int32 wx, Int32 wy, Int32 ww, Int32 wh, Int32 x, Int32 y, Int32 w, Int32 h, Int32 mode)

void	DrawImageRef (maxon::ImageBaseRef &imageRef, Float wx, Float wy, Float ww, Float wh, Float opacity, maxon::IMAGEINTERPOLATIONMODE mode)

void	DrawText (const maxon::String &txt, Int32 x, Int32 y, Int32 flags=(0\|(0<< 4)))

void	DrawBezierLine (const Vector2d &startPoint, const maxon::Block< const BezierPoint > &bezierPoints, Bool closed, Float lineWidth=1.0, LINESTYLE lineStyle=LINESTYLE::NORMAL)

void	DrawBezierFill (const Vector2d &startPoint, const maxon::Block< const BezierPoint > &bezierPoints, Bool closed)

void	DrawPolyLine (const maxon::Block< const Vector2d > &p, Bool closed, Float lineWidth=1.0, LINESTYLE lineStyle=LINESTYLE::NORMAL)

void	DrawPolyFill (const maxon::Block< const Vector2d > &p, Bool closed)

void	DrawEllipseLine (const Vector2d &centerPoint, const Vector2d &radius, Float lineWidth=1.0, LINESTYLE lineStyle=LINESTYLE::NORMAL)

void	DrawEllipseFill (const Vector2d &centerPoint, const Vector2d &radius)

void	DrawCustomButton (Int32 x, Int32 y, Int32 w, Int32 h, const Int32 *ids, Bool nofill, Bool focus)

void	FillBitmapBackground (BaseBitmap *bmp, Int32 offsetx, Int32 offsety)

void	DrawSetFont (Int32 fontid)

Int32	DrawGetTextWidth (const maxon::String &text) const

Int32	DrawGetTextWidth_ListNodeName (BaseList2D *node, Int32 fontid=FONT_STANDARD) const

Int32	DrawGetTextIndexFromPixel (const maxon::String &text, Float pixelPosition) const

Int32	DrawGetFontHeight () const

Int32	DrawGetFontBaseLine () const

const maxon::OSFontObjectRef &	DrawGetFontObject () const

void	DrawSetTextRotation (Float textrotation)

Clipping
void	SetClippingRegion (Int32 x, Int32 y, Int32 w, Int32 h)

void	ClearClippingRegion ()

Bool	OffScreenOn ()

Bool	OffScreenOn (Int32 x, Int32 y, Int32 w, Int32 h)

Miscellaneous
void	ScrollArea (Int32 xdiff, Int32 ydiff, Int32 x, Int32 y, Int32 w, Int32 h)

Float	GetPixelRatio () const

Coordinates Transformation
Bool	Local2Global (Int32 x, Int32 y) const

Bool	Local2Global (Float &x, Float &y) const

Bool	Global2Local (Int32 x, Int32 y) const

Bool	Global2Local (Float &x, Float &y) const

Bool	Local2Screen (Int32 x, Int32 y) const

Bool	Local2Screen (Float &x, Float &y) const

Bool	Screen2Local (Int32 x, Int32 y) const

Bool	Screen2Local (Float &x, Float &y) const

Drag and Drop
Bool	GetDragPosition (const BaseContainer &msg, Int32 x, Int32 y) const

Bool	GetDragObject (const BaseContainer &msg, Int32 type, void *object) const

Bool	HandleMouseDrag (const BaseContainer &msg, Int32 type, void *data, Int32 dragflags)

Bool	SetDragDestination (Int32 cursor)

Border
void	GetBorderSize (Int32 type, Int32 l, Int32 t, Int32 r, Int32 b) const

void	DrawBorder (Int32 type, Int32 x1, Int32 y1, Int32 x2, Int32 y2)

Bool	CheckDropArea (const BaseContainer &msg, Bool horiz, Bool vert) const

Mouse Drag
void	MouseDragStart (Int32 button, Float mx, Float my, MOUSEDRAGFLAGS flag)

MOUSEDRAGRESULT	MouseDrag (Float mx, Float my, BaseContainer *channels)

MOUSEDRAGRESULT	MouseDragEnd ()

Constructor & Destructor Documentation

◆ GeUserArea()

GeUserArea ( )

Constructs a user area that is not attached to any dialog.

Note: The user area must be attached to a dialog with GeDialog::AttachUserArea() before it can be used.

◆ ~GeUserArea()

virtual ~GeUserArea ( )

virtual

Destroys the user area.

Member Function Documentation

◆ MAXON_DISALLOW_COPY_AND_ASSIGN()

MAXON_DISALLOW_COPY_AND_ASSIGN ( GeUserArea )

private

◆ Get()

CUserArea* Get ( )

Gets the internal representation of the user area.
Needed by some areas in the API for historical reasons.

Returns: The internal user area representation. nullptr if the user area is not attached to a dialog.

◆ Set()

void Set ( CUserArea * t_cu )

Sets the internal representation of the user area.
Needed by some areas in the API for historical reasons.

Parameters

[in] t_cu An internal user area representation.

◆ GetDialog()

GeDialog* GetDialog ( )

Gets the user area's parent dialog.

Returns: The pointer to the user area's parent dialog.

◆ Init()

virtual Bool Init ( )

virtual

Called once when the user area is initialized by the GUI, before the layout is calculated.
Override this function to initialize anything.

Returns: true if successful, or false to signalize an error.

◆ InitValues()

virtual Bool InitValues ( )

virtual

Called after the layout is calculated, before the user area is drawn.
Override this function to initialize anything.

Returns: true if successful, or false to signalize an error.

◆ GetMinSize()

virtual Bool GetMinSize	(	Int32 &	w,
		Int32 &	h
	)

virtual

Called to specify a minimum size for the user area.
Override this function to set the minimum size of the user area to w and h.

Parameters

[in]	w	Assign the minimum width in pixels.
[in]	h	Assign the minimum height in pixels.

Returns: true if successful, or false to signalize an error.

◆ Sized()

virtual void Sized	(	Int32	w,
		Int32	h
	)

virtual

Called when the user area is resized.
Override this function to update anything.

Parameters

[in]	w	The new width in pixels.
[in]	h	The new height in pixels.

◆ Draw()

virtual OBSOLETE Draw	(	Int32	x1,
		Int32	y1,
		Int32	x2,
		Int32	y2
	)

virtual

Deprecated.

◆ DrawMsg()

virtual void DrawMsg	(	Int32	x1,
		Int32	y1,
		Int32	x2,
		Int32	y2,
		const BaseContainer &	msg
	)

virtual

Called to draw the user area.
Use the drawing functions to update the user area in the region specified by the rectangle from (x1, y1) to (x2, y2).
Remember to use OffScreenOn() to avoid flickering.

Parameters

[in]	x1	The upper left X coordinate.
[in]	y1	The upper left Y coordinate.
[in]	x2	The lower right X coordinate.
[in]	y2	The lower right Y coordinate.
[in]	msg	The draw container.

◆ InputEvent()

virtual Bool InputEvent ( const BaseContainer & msg )

virtual

Called when an input event is received.
The information about the input event is stored in the msg container. See Input Events for more information.

See also: MOUSEMOVE_DELTA.

Parameters

[in] msg The event container.

Returns: true if the event was handled, otherwise false.

◆ CoreMessage()

virtual Bool CoreMessage	(	Int32	id,
		const BaseContainer &	msg
	)

virtual

Called when a core message is received.
The message type is given by id and the message information is stored in msg.

See also: The article Core Messages for more information.

Parameters

[in]	id	The message type: EVMSG
[in]	msg	The core message container.

Returns: Currently not used.

◆ Timer()

virtual void Timer ( const BaseContainer & msg )

virtual

Called when a timer event is received.
To subscribe to timer events use SetTimer().

Parameters

[in] msg The timer message container.

◆ Message()

virtual Int32 Message	(	const BaseContainer &	msg,
		BaseContainer &	result
	)

virtual

Called when a message is received.
Override this function to react to more messages than covered by the other virtual functions. Normally this is not necessary.

Note: If overriden, include a call to the base version of this function, GeUserArea::Message().

See also: The article GUI Messages for more information.

Parameters

[in]	msg	The message container.
[in]	result	A container to place results in.

Returns: Depends on the message.

◆ Redraw()

void Redraw ( Bool threaded = false )

Forces the user area to redraw itself.

Parameters

[in] threaded Must be set to true if the function is called from another thread than the main Cinema 4D thread.

◆ SendParentMessage()

Bool SendParentMessage ( const BaseContainer & msg )

Sends a custom message to the parent dialog.

See also: The article GUI Messages for more information.

Parameters

[in] msg The message container.

Returns: true if successful, otherwise false.

◆ SendParentMessageResult()

GeData SendParentMessageResult ( const BaseContainer & msg )

Sends a custom message to the parent dialog.

See also: The article GUI Messages for more information.

Parameters

[in] msg The message container.

Returns: returns the result of the message

◆ GetId()

Int32 GetId ( ) const

Gets the ID of the user area.

Returns: The user area ID.

◆ GetWidth()

Int32 GetWidth ( ) const

Gets the width in pixels of the user area.

Returns: The user area's width.

◆ GetHeight()

Int32 GetHeight ( ) const

Gets the height in pixels of the user area.

Returns: The user area's height.

◆ IsEnabled()

Bool IsEnabled ( ) const

Checks the enabled state of the user area.

Returns: true if the user area is enabled in the dialog, otherwise false.

◆ IsR2L()

Bool IsR2L ( ) const

Checks if the user area has to be drawn in right-to-left layout mode.

Returns: true if the user area is in right-to-left layout mode, otherwise false.

◆ HasFocus()

Bool HasFocus ( ) const

Checks if the user area has the focus.

Returns: true if the user area has the focus in the dialog, otherwise false.

◆ LayoutChanged()

void LayoutChanged ( )

Tells Cinema 4D that the user area has new dimensions. That causes Cinema 4D to call:

GetMinSize()
Sized()
InitValues()
Draw()
The dialog's layout is recalculated in this process.

◆ SetTimer()

void SetTimer ( Int32 timer )

Initializes the timer clock, so that Timer() is called every timer milliseconds. Use SetTimer(0) to stop the timer.

Note: Depending on the speed of the computer, the operating system, the complexity of the dialog and the threads running in the background, there is no guarantee that event messages will occur on a regular basis.
Using a value of 500 ms should be no problem but using a value of 1 ms one might get events with the following time spaces: 3 ms, 76 ms, 15 ms, 19 ms, 67 ms etc.

Warning: Keep in mind that using small timer values results in heavy message traffic in the application which may slow down Cinema 4D (and all other applications running on the computer) to a point where nothing is working any longer besides the dialog.

Parameters

[in] timer The timer interval in milliseconds. Pass 0 to stop the timer.

◆ GetInputState()

Bool GetInputState	(	Int32	askdevice,
		Int32	askchannel,
		BaseContainer &	res
	)		const

Polls a certain channel of a device for the current input state.
If the return value is true, the container stored in res is like an input event message, otherwise no state was available.
For a list of valid devices and channels, see Input Events.

Parameters

[in]	askdevice	The device to ask.
[in]	askchannel	The channel of the device.
[in]	res	The result container.

Returns: true if an input state could be retrieved, otherwise false.

◆ GetInputEvent()

Bool GetInputEvent	(	Int32	askdevice,
		BaseContainer &	res
	)		const

Gets the next input event for a certain device from the event queue.
If the return value is true, the container stored in res is like an input event message, otherwise no state was available.
For a list of valid devices and channels, see Input Events.

Parameters

[in]	askdevice	The device to poll.
[in]	res	The result container.

Returns: true if an input event could be retrieved, otherwise false.

◆ KillEvents()

void KillEvents ( )

Flushes all events from the window message queue.
For example if looping while the mouse is down (polling), call this function to flush all key downs/mouse clicks that are made during the loop.

◆ IsHotkeyDown()

HOTKEYFLAGS IsHotkeyDown ( Int32 id ) const

Checks the standard navigation hotkeys.

Parameters

[in] id The hotkey to check: HOTKEY

Returns: A value != 0 if the hotkey is pressed.

◆ DrawSetPen() [1/3]

void DrawSetPen ( const Vector & color )

Sets the draw color.

Parameters

[in] color A color vector.

◆ DrawSetPen() [2/3]

void DrawSetPen ( Int32 id )

Sets the draw color.

Note: To draw the default background color please use GeUserArea::DrawSetPenToParentBackgroundColor() instead of the classic DrawSetPen(COLOR_BG).

Parameters

[in] id A color constant: COLOR

◆ DrawGetPenColor()

Vector DrawGetPenColor ( Int32 id ) const

Gets the RGB value of a color ID.

Parameters

[in] id A color constant: COLOR

Returns: The RGB value of the color.

◆ DrawSetPen() [3/3]

void DrawSetPen ( const GeData & d )

Sets the draw color.

Parameters

[in] d A color data. Can be either a color vector or a color constant in the GeData.

◆ DrawSetPenToParentBackgroundColor()

void DrawSetPenToParentBackgroundColor ( )

Sets the draw color to the parent group brackground color.

See also: GeUserArea::GetBackgroundColor(). @Note Use this instead of the classic DrawSetPen(COLOR_BG). This is equivalent to DrawSetPen(GetParentBackgroundColor()).

◆ GetParentBackgroundColor()

GeData GetParentBackgroundColor ( ) const

Gets the parent group background color. Can be either a color vector in range [0, 1] or a color constant of type Int32: COLOR

Note: Take in mind the parent group color may be different than the classic COLOR_BG if either the flag BFV_GRIDGROUP_ROUNDED_BACKGROUND is set or the parent group color has been customized with GeDialog::SetGroupBackgroundColor() and GeDialog::SetGroupInnerBackgroundColor().

Returns: The parent group background color.

◆ DrawSetOpacity()

void DrawSetOpacity ( Float opacity )

Sets the opacity value.

Parameters

[in] opacity The opacity.