Text Class

previous page next page

SFML.Net

Text Class

This class defines a graphical 2D text, that can be drawn on screen

Inheritance Hierarchy

SystemObject  SFMLObjectBase
    SFML.GraphicsTransformable
      SFML.GraphicsText

Namespace: SFML.Graphics
Assembly: sfmlnet-graphics-2 (in sfmlnet-graphics-2.dll) Version: 2.2.0.0 (2.2.0)

Syntax

public class Text : Transformable, Drawable

Public Class Text
	Inherits Transformable
	Implements Drawable

public ref class Text : public Transformable, 
	Drawable

type Text =  
    class
        inherit Transformable
        interface Drawable
    end

The Text type exposes the following members.

Constructors

	Name	Description
	Text	Default constructor
	Text(Text)	Construct the text from another text
	Text(String, Font)	Construct the text from a string and a font
	Text(String, Font, UInt32)	Construct the text from a string, font and size

Methods

	Name	Description
	Destroy	Handle the destruction of the object (Overrides TransformableDestroy(Boolean).)
	Dispose	Explicitely dispose the object (Inherited from ObjectBase.)
	Draw
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Dispose the object (Inherited from ObjectBase.)
	FindCharacterPos	Return the visual position of the Index-th character of the text, in coordinates relative to the text (note : translation, origin, rotation and scale are not applied)
	GetGlobalBounds	Get the global bounding rectangle of the entity. The returned rectangle is in global coordinates, which means that it takes in account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the sprite in the global 2D world's coordinate system.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLocalBounds	Get the local bounding rectangle of the entity. The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Provide a string describing the object (Overrides ObjectToString.)

Properties

	Name	Description
	CharacterSize	Base size of characters
	Color	Global color of the object
	CPointer	Access to the internal pointer of the object. For internal use only (Inherited from ObjectBase.)
	DisplayedString	String which is displayed
	Font	Font used to display the text
	InverseTransform	The combined transform of the object (Inherited from Transformable.)
	Origin	The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). (Inherited from Transformable.)
	Position	Position of the object (Inherited from Transformable.)
	Rotation	Rotation of the object (Inherited from Transformable.)
	Scale	Scale of the object (Inherited from Transformable.)
	Style	Style of the text (see Styles enum)
	Transform	The combined transform of the object (Inherited from Transformable.)

Remarks

See also the note on coordinates and undistorted rendering in SFML.Graphics.Transformable.

previous page start next page