C# Класс UILabel, TheUnseen

Наследование: UIWidget
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
keepCrispWhenShrunk Crispness

Private Properties

Свойство Тип Описание
GetCharacterIndex int
GetCharacterIndex int
OnFontTextureChanged void

Открытые методы

Метод Описание
ApplyShadow ( BetterList verts, BetterList uvs, BetterList cols, int start, int end, float x, float y ) : void

Apply a shadow effect to the buffer.
AssumeNaturalSize ( ) : void

Make the label assume its natural size.
CalculateOffsetToFit ( string text ) : int

Calculate the character index offset necessary in order to print the end of the specified text.
GetCharacterIndex ( int currentIndex, KeyCode, key ) : int

Get the index of the character on the line directly above or below the current index.
GetCharacterIndexAtPosition ( Vector2 localPos ) : int

Return the index of the character at the specified local position.
GetCharacterIndexAtPosition ( Vector3 worldPos ) : int

Return the index of the character at the specified world position.
GetSides ( Transform relativeTo ) : Vector3[]

Get the sides of the rectangle relative to the specified transform. The order is left, top, right, bottom.
GetUrlAtCharacterIndex ( int characterIndex ) : string

Retrieve the URL right under the specified character index.
GetUrlAtPosition ( Vector2 localPos ) : string

Retrieve the URL directly below the specified relative-to-label position.
GetUrlAtPosition ( Vector3 worldPos ) : string

Retrieve the URL directly below the specified world-space position.
GetWordAtCharacterIndex ( int characterIndex ) : string

Retrieve the word right under the specified character index.
GetWordAtPosition ( Vector2 localPos ) : string

Retrieve the word directly below the specified relative-to-label position.
GetWordAtPosition ( Vector3 worldPos ) : string

Retrieve the word directly below the specified world-space position.
MakePixelPerfect ( ) : void

Text is pixel-perfect when its scale matches the size.
MarkAsChanged ( ) : void

UILabel needs additional processing when something changes.
OnFill ( BetterList verts, BetterList uvs, BetterList cols ) : void

Draw the label.
PrintOverlay ( int start, int end, UIGeometry, caret, UIGeometry, highlight, Color caretColor, Color highlightColor ) : void

Fill the specified geometry buffer with vertices that would highlight the current selection.
ProcessAndRequest ( ) : void

Request the needed characters in the texture.
ProcessText ( ) : void

Process the raw text, called when something changes.
ProcessText ( bool legacyMode ) : void

Process the raw text, called when something changes.
SetCurrentPercent ( ) : void

Convenience function, in case you wanted to associate progress bar, slider or scroll bar's OnValueChanged function in inspector with a label.
SetCurrentProgress ( ) : void

Convenience function, in case you wanted to associate progress bar, slider or scroll bar's OnValueChanged function in inspector with a label.
SetCurrentSelection ( ) : void

Convenience function, in case you wanted to automatically set some label's text by selecting a value in the UIPopupList.
UpdateNGUIText ( ) : void

Update NGUIText.current with all the properties from this label.
UpdateNGUIText ( int size, int lineWidth, int lineHeight ) : void

Update NGUIText.current with all the properties from this label.
Wrap ( string text, string &final ) : bool

Convenience function -- wrap the current text given the label's settings and unlimited height.
Wrap ( string text, string &final, int height ) : bool

Convenience function -- wrap the current text given the label's settings and the given height.

Защищенные методы

Метод Описание
ApplyOffset ( BetterList verts, int start ) : Vector2

Align the vertices, making the label positioned correctly based on the pivot. Returns the offset that was applied.
OnAnchor ( ) : void

If the label is anchored it should not auto-resize.
OnDisable ( ) : void

Remove the font texture change listener.
OnInit ( ) : void

Register the font texture change listener.
OnStart ( ) : void

Determine start-up values.
OnValidate ( ) : void

Validate the properties.
SetActiveFont ( Font fnt ) : void

Set the active font, correctly setting and clearing callbacks.
UpgradeFrom265 ( ) : void

Upgrading labels is a bit different.

Приватные методы

Метод Описание
GetCharacterIndex ( Vector2 localPos ) : int
GetCharacterIndex ( Vector3 worldPos ) : int
OnFontTextureChanged ( ) : void

Notification called when the Unity's font's texture gets rebuilt. Unity's font has a nice tendency to simply discard other characters when the texture's dimensions change. By requesting them inside the notification callback, we immediately force them back in. Originally I was subscribing each label to the font individually, but as it turned out mono's delegate system causes an insane amount of memory allocations when += or -= to a delegate. So... queue yet another work-around.

Описание методов

ApplyOffset() защищенный Метод

Align the vertices, making the label positioned correctly based on the pivot. Returns the offset that was applied.
protected ApplyOffset ( BetterList verts, int start ) : Vector2
verts BetterList
start int
Результат Vector2

ApplyShadow() публичный Метод

Apply a shadow effect to the buffer.
public ApplyShadow ( BetterList verts, BetterList uvs, BetterList cols, int start, int end, float x, float y ) : void
verts BetterList
uvs BetterList
cols BetterList
start int
end int
x float
y float
Результат void

AssumeNaturalSize() публичный Метод

Make the label assume its natural size.
public AssumeNaturalSize ( ) : void
Результат void

CalculateOffsetToFit() публичный Метод

Calculate the character index offset necessary in order to print the end of the specified text.
public CalculateOffsetToFit ( string text ) : int
text string
Результат int

GetCharacterIndex() публичный Метод

Get the index of the character on the line directly above or below the current index.
public GetCharacterIndex ( int currentIndex, KeyCode, key ) : int
currentIndex int
key KeyCode,
Результат int

GetCharacterIndexAtPosition() публичный Метод

Return the index of the character at the specified local position.
public GetCharacterIndexAtPosition ( Vector2 localPos ) : int
localPos Vector2
Результат int

GetCharacterIndexAtPosition() публичный Метод

Return the index of the character at the specified world position.
public GetCharacterIndexAtPosition ( Vector3 worldPos ) : int
worldPos Vector3
Результат int

GetSides() публичный Метод

Get the sides of the rectangle relative to the specified transform. The order is left, top, right, bottom.
public GetSides ( Transform relativeTo ) : Vector3[]
relativeTo Transform
Результат Vector3[]

GetUrlAtCharacterIndex() публичный Метод

Retrieve the URL right under the specified character index.
public GetUrlAtCharacterIndex ( int characterIndex ) : string
characterIndex int
Результат string

GetUrlAtPosition() публичный Метод

Retrieve the URL directly below the specified relative-to-label position.
public GetUrlAtPosition ( Vector2 localPos ) : string
localPos Vector2
Результат string

GetUrlAtPosition() публичный Метод

Retrieve the URL directly below the specified world-space position.
public GetUrlAtPosition ( Vector3 worldPos ) : string
worldPos Vector3
Результат string

GetWordAtCharacterIndex() публичный Метод

Retrieve the word right under the specified character index.
public GetWordAtCharacterIndex ( int characterIndex ) : string
characterIndex int
Результат string

GetWordAtPosition() публичный Метод

Retrieve the word directly below the specified relative-to-label position.
public GetWordAtPosition ( Vector2 localPos ) : string
localPos Vector2
Результат string

GetWordAtPosition() публичный Метод

Retrieve the word directly below the specified world-space position.
public GetWordAtPosition ( Vector3 worldPos ) : string
worldPos Vector3
Результат string

MakePixelPerfect() публичный Метод

Text is pixel-perfect when its scale matches the size.
public MakePixelPerfect ( ) : void
Результат void

MarkAsChanged() публичный Метод

UILabel needs additional processing when something changes.
public MarkAsChanged ( ) : void
Результат void

OnAnchor() защищенный Метод

If the label is anchored it should not auto-resize.
protected OnAnchor ( ) : void
Результат void

OnDisable() защищенный Метод

Remove the font texture change listener.
protected OnDisable ( ) : void
Результат void

OnFill() публичный Метод

Draw the label.
public OnFill ( BetterList verts, BetterList uvs, BetterList cols ) : void
verts BetterList
uvs BetterList
cols BetterList
Результат void

OnInit() защищенный Метод

Register the font texture change listener.
protected OnInit ( ) : void
Результат void

OnStart() защищенный Метод

Determine start-up values.
protected OnStart ( ) : void
Результат void

OnValidate() защищенный Метод

Validate the properties.
protected OnValidate ( ) : void
Результат void

PrintOverlay() публичный Метод

Fill the specified geometry buffer with vertices that would highlight the current selection.
public PrintOverlay ( int start, int end, UIGeometry, caret, UIGeometry, highlight, Color caretColor, Color highlightColor ) : void
start int
end int
caret UIGeometry,
highlight UIGeometry,
caretColor Color
highlightColor Color
Результат void

ProcessAndRequest() публичный Метод

Request the needed characters in the texture.
public ProcessAndRequest ( ) : void
Результат void

ProcessText() публичный Метод

Process the raw text, called when something changes.
public ProcessText ( ) : void
Результат void

ProcessText() публичный Метод

Process the raw text, called when something changes.
public ProcessText ( bool legacyMode ) : void
legacyMode bool
Результат void

SetActiveFont() защищенный Метод

Set the active font, correctly setting and clearing callbacks.
protected SetActiveFont ( Font fnt ) : void
fnt Font
Результат void

SetCurrentPercent() публичный Метод

Convenience function, in case you wanted to associate progress bar, slider or scroll bar's OnValueChanged function in inspector with a label.
public SetCurrentPercent ( ) : void
Результат void

SetCurrentProgress() публичный Метод

Convenience function, in case you wanted to associate progress bar, slider or scroll bar's OnValueChanged function in inspector with a label.
public SetCurrentProgress ( ) : void
Результат void

SetCurrentSelection() публичный Метод

Convenience function, in case you wanted to automatically set some label's text by selecting a value in the UIPopupList.
public SetCurrentSelection ( ) : void
Результат void

UpdateNGUIText() публичный Метод

Update NGUIText.current with all the properties from this label.
public UpdateNGUIText ( ) : void
Результат void

UpdateNGUIText() публичный Метод

Update NGUIText.current with all the properties from this label.
public UpdateNGUIText ( int size, int lineWidth, int lineHeight ) : void
size int
lineWidth int
lineHeight int
Результат void

UpgradeFrom265() защищенный Метод

Upgrading labels is a bit different.
protected UpgradeFrom265 ( ) : void
Результат void

Wrap() публичный Метод

Convenience function -- wrap the current text given the label's settings and unlimited height.
public Wrap ( string text, string &final ) : bool
text string
final string
Результат bool

Wrap() публичный Метод

Convenience function -- wrap the current text given the label's settings and the given height.
public Wrap ( string text, string &final, int height ) : bool
text string
final string
height int
Результат bool

Описание свойств

keepCrispWhenShrunk публичное свойство

Whether the label will keep its content crisp even when shrunk. You may want to turn this off on mobile devices.
public Crispness keepCrispWhenShrunk
Результат Crispness