• Inicio
• SpriteText

C# Class SpriteText, marblemadness

Mostrar archivo Open project: MtvnGames/marblemadness Class Usage Examples

Public Properties

Property	Type	Description
alignment	Alignment_Type
anchor	Anchor_Pos
characterSize	float
characterSpacing	float
color	Color
dynamicLength	bool
font	UnityEngine.TextAsset
hideAtStart	bool
ignoreClipping	bool
lineSpacing	float
maskingCharacter	string
maxWidth	float
multiline	bool
offsetZ	float
parseColorTags	bool
password	bool
persistent	bool
pixelPerfect	bool
removeUnsupportedCharacters	bool
renderCamera	Camera
tabSize	int
text	string

Protected Properties

Property	Type	Description
UVs	Vector2[]
capacity	int
clipped	bool
clippingRect	Rect3D
colDel	string[]
colors	Color[]
commaDelimiter	char[]
displayString	string
faces	int[]
lineSpaceSize	float
localClipRect	Rect
m_awake	bool
m_hidden	bool
m_started	bool
mesh	Mesh
meshColors	Color[]
meshFilter	UnityEngine.MeshFilter
meshRenderer	UnityEngine.MeshRenderer
meshString	string
mirror	SpriteTextMirror,
newLineDelimiter	char[]
newLineInserts	List
oldMesh	Mesh
plainText	string
screenPlacer	EZScreenPlacement,
screenSize	Vector2
spriteFont	SpriteFont,
stringContentChanged	bool
tabSpaces	string
texture	Texture
topLeft	Vector3
totalWidth	float
unclippedTL	Vector3
updateClipping	bool
updateColors	bool
vertices	Vector3[]
worldUnitsPerScreenPixel	float
worldUnitsPerTexel	float
worldUnitsPerUV	Vector2

Public Methods

Method	Description
CalcSize ( ) : void
Copy ( SpriteText, s ) : void	Duplicates the settings of another SpriteText object.
Delete ( ) : void	Call Delete() before destroying this component or the GameObject to which it is attached. Memory leaks can ensue otherwise.
DisplayIndexToPlainIndex ( int dispCharIndex ) : int	Converts a character index in the display text string to a corresponding index in the plain text string.
DoMirror ( ) : void
GetCenterPoint ( ) : Vector3	Gets the center point of the text's extents in local space.
GetDisplayLineCount ( ) : int	Returns the number of lines actually being displayed, as opposed to the number of lines in the string assigned to the object. In other words, if word-wrapping is being used, the number of actual lines displayed may be more than the number of lines in the actual string.
GetDisplayLineCount ( int charIndex, int &charLine, int &lineStart, int &lineEnd ) : int	Returns the number of lines actually being displayed, as opposed to the number of lines in the string assigned to the object. In other words, if word-wrapping is being used, the number of actual lines displayed may be more than the number of lines in the actual string. It also stores the line number of the character at the specified index in the string.
GetInsertionPointPos ( int charIndex ) : Vector3	Returns the position, in world space, of the insertion point relative to a specified character (specified by index). The position returned is at the left edge of, and the baseline of, the specified character.
GetNearestInsertionPoint ( Vector3 point ) : int	Returns both the world-space position of the insertion point most nearly matching the specified point, as well as the index of the character to the left of which the insertion point corresponds.
GetNearestInsertionPointPos ( Vector3 point, int &insertionPt ) : Vector3	Returns both the world-space position of the insertion point most nearly matching the specified point, as well as the index of the character to the left of which the insertion point corresponds.
GetScreenWidth ( string s ) : float	Returns the width, in screen pixels, of the specified string were it to be rendered using the current font and settings. NOTE: Assumes the string is a single line.
GetVertices ( ) : Vector3[]	Returns a reference to the text's vertices.
GetWidth ( string s ) : float	Returns the width, in world units, of the specified string were it to be rendered using the current font and settings. NOTE: Assumes the string is a single line.
Hide ( bool tf ) : void	Hides or displays the text by disabling/enabling the mesh renderer component.
IsHidden ( ) : bool	Returns whether the text is currently set to be hidden (whether its mesh renderer component is enabled).
OnDestroy ( ) : void
OnDrawGizmos ( ) : void
OnDrawGizmosSelected ( ) : void
OnEnable ( ) : void
PixelCoordToUVCoord ( Vector2 xy ) : Vector2	Converts pixel coordinates to UV coordinates according to the currently assigned material. NOTE: This is for converting coordinates and will reverse the Y component accordingly. For converting widths and heights, use PixelSpaceToUVSpace()!
PixelCoordToUVCoord ( int x, int y ) : Vector2	Converts pixel coordinates to UV coordinates according to the currently assigned material. NOTE: This is for converting coordinates and will reverse the Y component accordingly. For converting widths and heights, use PixelSpaceToUVSpace()!
PixelSpaceToUVSpace ( Vector2 xy ) : Vector2	Converts pixel-space values to UV-space scalar values according to the currently assigned material. NOTE: This is for converting widths and heights-not coordinates (which have reversed Y-coordinates). For coordinates, use PixelCoordToUVCoord()!
PixelSpaceToUVSpace ( int x, int y ) : Vector2	Converts pixel-space values to UV-space scalar values according to the currently assigned material. NOTE: This is for converting widths and heights-not coordinates (which have reversed Y-coordinates). For coordinates, use PixelCoordToUVCoord()!
PlainIndexToDisplayIndex ( int plainCharIndex ) : int	Converts a character index in the plain text string to a corresponding index in the display string.
SetAlignment ( Alignment_Type a ) : void	Sets the alignment of the text (left, right, center).
SetAnchor ( Anchor_Pos a ) : void	Sets the anchor type to use. See Anchor_Pos
SetCamera ( ) : void	A no-argument version of SetCamera() that simply re-assigns the same camera to the object, forcing it to recalculate all camera-dependent calculations.
SetCamera ( Camera c ) : void	Sets the camera to use when calculating a pixel-perfect character size.
SetCharacterSize ( float size ) : void	Sets the size (height) of the text such that a capital character that extends from the baseline to the absolute top of the line will be the specified height in world units. All other characters will be sized proportionately. If called while set to pixel perfect, pixel-perfect will be automatically disabled.
SetColor ( Color c ) : void	Sets the text's color to the specified color. NOTE: Will not override color tags in the text itself.
SetFont ( SpriteFont, newFont, Material fontMaterial ) : void	Changes the font to be used for this text object.
SetFont ( TextAsset newFont, Material fontMaterial ) : void	Changes the font to be used for this text object.
SetLineSpacing ( float spacing ) : void	Sets the spacing between lines as a percentage of the character size. i.e. a value of 1.1 means 10% of the height of a full-height character will be placed between lines.
SetPixelToUV ( Texture tex ) : void
SetPixelToUV ( int texWidth, int texHeight ) : void
Start ( ) : void
Unclip ( ) : void	Removes any clipping that is being applied to the text object.
Update ( ) : void
UpdateCamera ( ) : void	Updates any camera-dependent settings, such as the calculated pixel-perfect size. Use this with BroadcastMessage() to do bulk re-calculation of object sizes whenever your screensize/resolution changes at runtime.
UpdateMesh ( ) : void

Protected Methods

Method	Description
Awake ( ) : void
BuildCharacter ( int vertNum, int charNum, Vector3 upperLeft, SpriteChar &ch ) : void
ClearMesh ( ) : void
CreateMesh ( ) : void
DoSingleLineTruncation ( ) : void
EnlargeMesh ( ) : void
GetLineBaseline ( int numLines, int lineNum ) : float
GetStartPos_SingleLine ( float baseHeight, float width ) : Vector3
Init ( ) : void
LayoutText ( ) : void
Layout_Line ( Vector3 startPos, string txt, int charIdx ) : void
Layout_Multiline ( string lines ) : void
Layout_Single_Line ( ) : void
OnDisable ( ) : void
ParseColor ( string str ) : Color
ParseHexColor ( string str ) : Color
ProcessString ( string str ) : void
ZeroQuad ( int i ) : void

Method Details

Property Details