CharacterAttributeKit

class HPS.CharacterAttributeKit : HPS.Kit

The CharacterAttributeKit class is a user space object. It is used to specify attributes that can be applied to individial character of a text object.

Public Functions

CharacterAttributeKit ()

The default constructor creates an empty CharacterAttributeKit object.

CharacterAttributeKit (HPS.CharacterAttributeKit in_kit)

The copy constructor creates a new CharacterAttributeKit object that contains the same settings as the source CharacterAttributeKit.

Param in_kit:The source CharacterAttributeKit to copy.

override void Dispose ()

override bool Empty ()

Indicates whether this CharacterAttributeKit has any values set on it.

Return:true if no values are set on this CharacterAttributeKit, false otherwise.

bool Equals (HPS.CharacterAttributeKit in_kit)

Check if the source CharacterAttributeKit is equivalent to this CharacterAttributeKit.

Param in_kit:The source CharacterAttributeKit to compare to this CharacterAttributeKit. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return:The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.CharacterAttributeKit in_kit)

Copies the source CharacterAttributeKit into this CharacterAttributeKit.

Param in_kit:The source CharacterAttributeKit to copy.

HPS.CharacterAttributeKit SetColor (HPS.RGBColor in_color)

Sets the color for the character(s).

Param in_color:The color for the character(s). Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit SetColor (int in_index)

Sets the color for the character(s).

Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit SetFont (string in_font)

Sets the font for the character(s).

Param in_font:The font for the character(s). Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit SetHorizontalOffset (float offset, HPS.Text.SizeUnits units)

Sets the horizontal offset to use for the character(s).

Return:A reference to this TextKit.

HPS.CharacterAttributeKit SetInvisible ()

Sets invisibility for the character(s).

Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit SetOmitted ()

Sets omission for the character(s).

Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit SetRotation (float in_rotation)

Sets the rotation for the character(s).

Param in_rotation:  The rotation for the character(s). Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit SetRotation (float in_rotation, bool in_fixed)

Sets the rotation for the character(s).

Param in_rotation:  The rotation for the character(s). Param in_fixed:Whether the rotation is fixed to screen space rather than following the character path (default is false). Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit SetSize (float size, HPS.Text.SizeUnits units)

Sets the font size to use for the character(s).

Return:A reference to this TextKit.

HPS.CharacterAttributeKit SetSlant (float in_slant)

Sets the slant for the character(s).

Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit SetVerticalOffset (float offset, HPS.Text.SizeUnits units)

Sets the font vertical offset to use for the character(s).

Return:A reference to this TextKit.

HPS.CharacterAttributeKit SetWidthScale (float in_scale)

Sets the width scaling for the character(s).

Param in_scale:The width scaling for the character(s). Return:A reference to this CharacterAttributeKit.

void Show (out HPS.CharacterAttributeKit out_kit)

Copies this CharacterAttributeKit into the given CharacterAttributeKit.

Param out_kit:The CharacterAttributeKit to populate with the contents of this CharacterAttributeKit.

bool ShowColor (out HPS.RGBColor out_color)

Shows the color.

Param out_color:  The color for the character(s). Return:true if a color was set, false otherwise.

bool ShowFont (out string out_font)

Shows the font to use for the character(s).

Param out_font:UTF8-encoded font name to use for the character(s). Return:true if a font was set, false otherwise.

bool ShowHorizontalOffset (out float out_offset, out HPS.Text.SizeUnits out_units)

Shows the horizontal offset to use for the character(s).

Param out_offset:  The offset for the character(s). Param out_units:  The units of the offset for the character(s). Return:true if an offset was set, false otherwise.

bool ShowInvisible ()

Shows the invisibility state.

Return:true if invisibility was set, false otherwise.

bool ShowOmitted ()

Shows the omission state.

Return:true if invisibility was set, false otherwise.

bool ShowRotation (out float out_rotation, out bool out_fixed)

Shows the rotation for the character(s).

Param out_rotation:  The rotation for the character(s). Param out_fixed:  Whether the rotation is fixed to sceen space. Return:true if a rotation was set, false otherwise.

bool ShowSize (out float out_size, out HPS.Text.SizeUnits out_units)

Shows the font size to use for the character(s).

Param out_size:The size for the character(s). Param out_units:  The units of the size for the character(s). Return:true if a size was set, false otherwise.

bool ShowSlant (out float out_slant)

Shows the slant for the character(s).

Param out_slant:  The slant for the character(s). Return:true if a slant was set, false otherwise.

bool ShowVerticalOffset (out float out_offset, out HPS.Text.SizeUnits out_units)

Shows the vertical offset to use for the character(s).

Param out_offset:  The offset for the character(s). Param out_units:  The units of the offset for the character(s). Return:true if an offset was set, false otherwise.

bool ShowWidthScale (out float out_scale)

Shows the width scaling for the character(s).

Param out_scale:  The width scaling for the character(s). Return:true if a width scale was set, false otherwise.

HPS.CharacterAttributeKit UnsetColor ()

Removes the color for the character(s).

Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit UnsetEverything ()

Removes all settings from this CharacterAttributeKit.

Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit UnsetFont ()

Removes the font for the character(s).

Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit UnsetHorizontalOffset ()

Removes the horizontal offset for the character(s).

Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit UnsetInvisible ()

Removes the invisibility for the character(s).

Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit UnsetOmitted ()

Removes the Omission for the character(s).

Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit UnsetRotation ()

Removes the rotation for the character(s).

Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit UnsetSize ()

Removes the size for the character(s).

Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit UnsetSlant ()

Removes the slant for the character(s).

Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit UnsetVerticalOffset ()

Removes the vertical offset for the character(s).

Return:A reference to this CharacterAttributeKit.

HPS.CharacterAttributeKit UnsetWidthScale ()

Removes the width scaling for the character(s).

Return:A reference to this CharacterAttributeKit.

Public Static Functions

bool operator!= (HPS.CharacterAttributeKit a, HPS.CharacterAttributeKit b)

bool operator== (HPS.CharacterAttributeKit a, HPS.CharacterAttributeKit b)