customgui_kerning.h File Reference

Classes
struct	Kerning
struct	KerningTriState
class	KerningData
class	KerningCustomGui
class	KerningVpGuiHelper
struct	KerningGetGuiHelperMsg

Macros
#define	CUSTOMDATATYPE_KERNING
#define	CUSTOMGUI_KERNING
#define	TEXTSPLINE_RESULTS
#define	MSG_DESCRIPTION_KERNINGDATACHANGED
#define	MSG_KERNING_GETGUIHELPER
#define	TEXTSPLINE_RESULT_X
#define	TEXTSPLINE_RESULT_Y
#define	TEXTSPLINE_RESULT_Y_BASE
#define	TEXTSPLINE_RESULT_HEIGHT_BASE
#define	TEXTSPLINE_RESULT_WIDTH
#define	TEXTSPLINE_RESULT_HEIGHT

Functions
Kerning	BlendKerning (const Kerning &k1, const Kerning &k2, Float mix)
Bool	HandleKerningMessages (GeListNode *node, Int32 msgId, Int32 kerningDescID, Int32 textDescID, void *msgData, KerningVpGuiHelper *guihelper)

Macro Definition Documentation

CUSTOMDATATYPE_KERNING

#define CUSTOMDATATYPE_KERNING

Plugin ID for the KerningData type.

CUSTOMGUI_KERNING

#define CUSTOMGUI_KERNING

Plugin ID for the KerningCustomGui.

TEXTSPLINE_RESULTS

#define TEXTSPLINE_RESULTS

Container ID for the text spline generation results.

MSG_DESCRIPTION_KERNINGDATACHANGED

#define MSG_DESCRIPTION_KERNINGDATACHANGED

ID for the message that sends changed KerningData to an object after a handle has been moved.

MSG_KERNING_GETGUIHELPER

#define MSG_KERNING_GETGUIHELPER

ID for the message that fetches the KerningVpGuiHelper pointer of an object.

Function Documentation

BlendKerning()

Kerning BlendKerning	(	const Kerning &	k1,
		const Kerning &	k2,
		Float	mix
	)

Blends the values of two Kerning objects, using simple linear interpolation.

Parameters

[in]	k1	The first Kerning object.
[in]	k2	The second Kerning object.
[in]	mix	The blend weight: 0.0 <= mix <= 1.0.

Returns

A Kerning object with the blended values.

HandleKerningMessages()

Bool HandleKerningMessages	(	GeListNode *	node,
		Int32	msgId,
		Int32	kerningDescID,
		Int32	textDescID,
		void *	msgData,
		KerningVpGuiHelper *	guihelper
	)

Takes care of all the messages that are important for the kerning viewport GUI to work.

Note

Simply call this from within a NodeData's Message function.

Parameters

[in]	node	Pass node from a NodeData::Message.
[in]	msgId	Pass msgId from a NodeData::Message.
[in]	kerningDescID	Pass descID from a NodeData::Message.
[in]	textDescID	The description ID of the text's string.
[in]	msgData	Pass msgData from a NodeData::Message.
[in]	guihelper	Pass the pointer to an allocated instance of a NodeData's KerningVpGuiHelper.

Returns

true if successful, otherwise false.