SplineCustomGui Class Reference

#include <customgui_splinecontrol.h>

Inheritance diagram for SplineCustomGui:

Detailed Description

Spline GUI (CUSTOMGUI_SPLINE) for SplineData.
Here are the settings: SplineCustomGuiSettings

Public Member Functions
void	SetMessageFunctions (SplineControlMessages *pFuncs)
SplineData *	GetSplineData (void)
Bool	SetSpline (SplineData *pData)
void	SetLabelText (maxon::String *strXMin=nullptr, maxon::String *strXMax=nullptr, maxon::String *strYMin=nullptr, maxon::String *strYMax=nullptr, maxon::String *strX=nullptr, maxon::String *strY=nullptr)
void	SetCustomColor (Bool bSet=false, Vector col=Vector(0.0, 0.0, 0.0))
void	GetScreenPosition (const Vector &v, Int32 &x, Int32 &y) const
void	GetValue (const Int32 x, const Int32 y, Vector &v) const
Bool	Command (Int32 id, const BaseContainer &msg)
Public Member Functions inherited from BaseCustomGui< 1009059 >
Int32	GetWidth ()
Int32	GetHeight ()
void	Redraw ()
Bool	LayoutChanged ()
Bool	Activate ()
Bool	SetDefaultForResEdit ()
Bool	SetData (const TriState< GeData > &tristate)
TriState< GeData >	GetData ()
void	SetLayoutMode (Int32 mode)
Int32	GetLayoutMode ()
Bool	SupportLayoutSwitch ()
Public Member Functions inherited from _BaseCustomGui
Int32	GetWidth (Int32 plugid)
Int32	GetHeight (Int32 plugid)
void	Redraw (Int32 plugid)
Bool	LayoutChanged (Int32 plugid)
Bool	Activate (Int32 plugid)
Bool	SetDefaultForResEdit (Int32 plugid)
Bool	SetData (Int32 plugid, const TriState< GeData > &tristate)
TriState< GeData >	GetData (Int32 plugid)
void	SetLayoutMode (Int32 plugid, Int32 mode)
Int32	GetLayoutMode (Int32 plugid)
Bool	SupportLayoutSwitch (Int32 plugid)

Private Member Functions
	SplineCustomGui ()
	~SplineCustomGui ()

Additional Inherited Members
Static Public Attributes inherited from BaseCustomGui< 1009059 >
static constexpr Int32	VALUE

Constructor & Destructor Documentation

SplineCustomGui()

SplineCustomGui ( )

private

~SplineCustomGui()

~SplineCustomGui ( )

private

Member Function Documentation

SetMessageFunctions()

void SetMessageFunctions

(

SplineControlMessages *

pFuncs

)

Registers a set of message functions.

Parameters

[in]

pFuncs

The message functions.

GetSplineData()

SplineData* GetSplineData

(

void

)

Gets the spline data.

Returns

The spline data. The spline GUI owns the pointed data.

SetSpline()

Bool SetSpline

(

SplineData *

pData

)

Sets the spline data.

Parameters

[in]

pData

The spline data to set.

Returns

true if successful, otherwise false.

SetLabelText()

void SetLabelText	(	maxon::String *	strXMin = nullptr,
		maxon::String *	strXMax = nullptr,
		maxon::String *	strYMin = nullptr,
		maxon::String *	strYMax = nullptr,
		maxon::String *	strX = nullptr,
		maxon::String *	strY = nullptr
	)

Sets the label text.

Parameters

[in]	strXMin	The minimum X value text to set, or nullptr (default).
[in]	strXMax	The maximum X value text to set, or nullptr (default).
[in]	strYMin	The minimum Y value text to set, or nullptr (default).
[in]	strYMax	The maximum Y value text to set, or nullptr (default).
[in]	strX	The new X text, or nullptr (default).
[in]	strY	The new Y text, or nullptr (default).

SetCustomColor()

void SetCustomColor	(	Bool	bSet = false,
		Vector	col = Vector(0.0, 0.0, 0.0)
	)

Sets the custom color for the curve.

Parameters

[in]	bSet	Pass true if a custom color should be used.
[in]	col	The custom color.

GetScreenPosition()

void GetScreenPosition	(	const Vector &	v,
		Int32 &	x,
		Int32 &	y
	)		const

Gets the screen position for a spline value.

Parameters

[in]	v	The spline value.
[out]	x	Assigned the screen X position.
[out]	y	Assigned the screen Y position.

GetValue()

void GetValue	(	const Int32	x,
		const Int32	y,
		Vector &	v
	)		const

Gets the spline value for a screen position.

Parameters

[in]	x	The screen X position.
[in]	y	The screen Y position.
[out]	v	Assigned the spline value.

Command()

Bool Command	(	Int32	id,
		const BaseContainer &	msg
	)

Triggers internal spline GUI commands. Example:

// Prepare the command message container
// We will make the SplineCustomGui frame the selected points
BaseContainer splineMsg;
splineMsg.SetInt32(0, IDC_SPLINE_FRAME_SEL);
 
// Get pointer to the SplineCustomGui
SplineCustomGui* pGui = (SplineCustomGui*)FindCustomGui(MYSPLINE, CUSTOMDATATYPE_SPLINE);
 
// Talk the SplineCustomGui into performing a command from its popup menu
if (pGui)
  pGui->Command(IDC_SPLINE_PRESET_POPUPMENU, splineMsg);

Parameters

[in]	id	The command ID: IDC_SPLINE_PRESET_POPUPMENU.
[in]	msg	The command message container: IDC_SPLINE

Returns

true if the command was successfully sent, otherwise false.