C# Класс Nez.UI.Element

Наследование: ILayout

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

Защищенные свойства (Protected)

Свойство	Тип	Описание
_debug	bool
_layoutEnabled	bool
_needsLayout	bool
_visible	bool
originX	float
rotation	float
scaleX	float
stage	Stage
touchable	Touchable

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

Метод	Описание
clipBegin ( Batcher batcher ) : bool	Calls clipBegin(Batcher, float, float, float, float) to clip this actor's bounds
clipBegin ( Batcher batcher, float x, float y, float width, float height ) : bool	Clips the specified screen aligned rectangle, specified relative to the transform matrix of the stage's Batch. The transform matrix and the stage's camera must not have rotational components. Calling this method must be followed by a call to clipEnd() if true is returned.
clipEnd ( Batcher batcher ) : void	Ends clipping begun by clipBegin(Batcher, float, float, float, float)
debugRender ( Graphics graphics ) : void	Draws this element's debug lines
draw ( Graphics graphics, float parentAlpha ) : void	If this method is overridden, the super method or {@link #validate()} should be called to ensure the widget is laid out.
getBottom ( ) : float	Returns y plus height
getColor ( ) : Color	Returns the color the element will be tinted when drawn
getDebug ( ) : bool
getHeight ( ) : float
getOriginX ( ) : float
getOriginY ( ) : float
getParent ( ) : Group	Returns the parent element, or null if not in a group
getRight ( ) : float	Returns x plus width
getRotation ( ) : float
getScaleX ( ) : float
getScaleY ( ) : float
getStage ( ) : Stage	Returns the stage that this element is currently in, or null if not in a stage.
getTouchable ( ) : Touchable
getWidth ( ) : float
getX ( ) : float	Returns the X position of the element's left edge
getX ( int alignment ) : float	Returns the X position of the specified {@link Align alignment}.
getY ( ) : float	Returns the Y position of the element's bottom edge
getY ( int alignment ) : float	Returns the Y position of the specified {@link Align alignment}
hasParent ( ) : bool	Returns true if the element's parent is not null
hit ( Vector2 point ) : Element
invalidate ( ) : void
invalidateHierarchy ( ) : void
isTouchable ( ) : bool	Returns true if input events are processed by this element.
isVisible ( ) : bool
layout ( ) : void
localToAscendantCoordinates ( Element ascendant, Vector2 localCoords ) : Vector2	Converts coordinates for this element to those of a parent element. The ascendant does not need to be a direct parent
localToParentCoordinates ( Vector2 localCoords ) : Vector2	Transforms the specified point in the element's coordinates to be in the parent's coordinates.
localToStageCoordinates ( Vector2 localCoords ) : Vector2	Transforms the specified point in the element's coordinates to be in the stage's coordinates
moveBy ( float x, float y ) : void	Add x and y to current position
pack ( ) : void
parentToLocalCoordinates ( Vector2 parentCoords ) : Vector2	Converts the coordinates given in the parent's coordinate system to this element's coordinate system.
remove ( ) : bool	Removes this element from its parent, if it has a parent
rotateBy ( float amountInDegrees ) : void	Adds the specified rotation to the current rotation
scaleBy ( float scale ) : void	Adds the specified scale to the current scale
scaleBy ( float scaleX, float scaleY ) : void	Adds the specified scale to the current scale
screenToLocalCoordinates ( Vector2 screenCoords ) : Vector2	Transforms the specified point in screen coordinates to the element's local coordinate system
setBounds ( float x, float y, float width, float height ) : void	Sets the x, y, width, and height.
setColor ( Color color ) : void
setDebug ( bool enabled ) : void	If true, {@link #debugDraw} will be called for this element
setHeight ( float height ) : void
setIsVisible ( bool visible ) : void
setOrigin ( float originX, float originY ) : void	Sets the origin position which is relative to the element's bottom left corner
setOrigin ( int alignment ) : void	Sets the origin position to the specified {@link Align alignment}.
setOriginX ( float originX ) : void
setOriginY ( float originY ) : void
setPosition ( float x, float y ) : Element	Sets the position of the element's bottom left corner
setPosition ( float x, float y, int alignment ) : void	Sets the position using the specified {@link Align alignment}. Note this may set the position to non-integer coordinates
setRotation ( float degrees ) : void
setScale ( float scaleXY ) : void	Sets the scale for both X and Y
setScale ( float scaleX, float scaleY ) : void	Sets the scale X and scale Y
setScaleX ( float scaleX ) : void
setScaleY ( float scaleY ) : void
setSize ( float width, float height ) : void
setTouchable ( Touchable touchable ) : void	Determines how touch events are distributed to this element. Default is {@link Touchable#enabled}.
setVisible ( bool visible ) : void	If false, the element will not be drawn and will not receive touch events. Default is true.
setWidth ( float width ) : void
setX ( float x ) : Element
setY ( float y ) : Element
setZIndex ( int index ) : void	Sets the z-index of this element. The z-index is the index into the parent's {@link Group#getChildren() children}, where a lower index is below a higher index. Setting a z-index higher than the number of children will move the child to the front. Setting a z-index less than zero is invalid.
stageToLocalCoordinates ( Vector2 stageCoords ) : Vector2	Transforms the specified point in the stage's coordinates to the element's local coordinate system.
toBack ( ) : void	Changes the z-order for this element so it is in back of all siblings
toFront ( ) : void	Changes the z-order for this element so it is in front of all siblings
validate ( ) : void

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

Метод	Описание
distanceOutsideBoundsToPoint ( Vector2 point ) : float	returns the distance from point to the bounds of element in the largest dimension or a negative number if the point is inside the bounds. Note that point should be in the element's coordinate system already.
positionChanged ( ) : void
rotationChanged ( ) : void
sizeChanged ( ) : void

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

Метод	Описание
areParentsVisible ( ) : bool	returns true if this Element and all parent Elements are visible
setParent ( Group parent ) : void	Called by the framework when an element is added to or removed from a group.
setStage ( Stage stage ) : void	Called by the framework when this element or any parent is added to a group that is in the stage. stage May be null if the element or any parent is no longer in a stage

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

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

Calls clipBegin(Batcher, float, float, float, float) to clip this actor's bounds

public clipBegin ( Batcher batcher ) : bool
batcher	Batcher
Результат	bool

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

Clips the specified screen aligned rectangle, specified relative to the transform matrix of the stage's Batch. The transform matrix and the stage's camera must not have rotational components. Calling this method must be followed by a call to clipEnd() if true is returned.

public clipBegin ( Batcher batcher, float x, float y, float width, float height ) : bool
batcher	Batcher
x	float
y	float
width	float
height	float
Результат	bool

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

Ends clipping begun by clipBegin(Batcher, float, float, float, float)

public clipEnd ( Batcher batcher ) : void
batcher	Batcher
Результат	void

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

Draws this element's debug lines

public debugRender ( Graphics graphics ) : void
graphics	Graphics	Graphics.
Результат	void

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

returns the distance from point to the bounds of element in the largest dimension or a negative number if the point is inside the bounds. Note that point should be in the element's coordinate system already.

protected distanceOutsideBoundsToPoint ( Vector2 point ) : float
point	Vector2
Результат	float

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

If this method is overridden, the super method or {@link #validate()} should be called to ensure the widget is laid out.

public draw ( Graphics graphics, float parentAlpha ) : void
graphics	Graphics	Graphics.
parentAlpha	float	Parent alpha.
Результат	void

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

Returns y plus height

public getBottom ( ) : float
Результат	float

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

Returns the color the element will be tinted when drawn

public getColor ( ) : Color
Результат	Color

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

public getDebug ( ) : bool
Результат	bool

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

public getHeight ( ) : float
Результат	float

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

public getOriginX ( ) : float
Результат	float

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

public getOriginY ( ) : float
Результат	float

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

Returns the parent element, or null if not in a group

public getParent ( ) : Group
Результат	Group

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

Returns x plus width

public getRight ( ) : float
Результат	float

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

public getRotation ( ) : float
Результат	float

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

public getScaleX ( ) : float
Результат	float

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

public getScaleY ( ) : float
Результат	float

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

Returns the stage that this element is currently in, or null if not in a stage.

public getStage ( ) : Stage
Результат	Stage

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

public getTouchable ( ) : Touchable
Результат	Touchable

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

public getWidth ( ) : float
Результат	float

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

Returns the X position of the element's left edge

public getX ( ) : float
Результат	float

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

Returns the X position of the specified {@link Align alignment}.

public getX ( int alignment ) : float
alignment	int	Alignment.
Результат	float

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

Returns the Y position of the element's bottom edge

public getY ( ) : float
Результат	float

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

Returns the Y position of the specified {@link Align alignment}

public getY ( int alignment ) : float
alignment	int	Alignment.
Результат	float

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

Returns true if the element's parent is not null

public hasParent ( ) : bool
Результат	bool

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

public hit ( Vector2 point ) : Element
point	Vector2
Результат	Element

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

public invalidate ( ) : void
Результат	void

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

public invalidateHierarchy ( ) : void
Результат	void

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

Returns true if input events are processed by this element.

public isTouchable ( ) : bool
Результат	bool

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

public isVisible ( ) : bool
Результат	bool

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

public layout ( ) : void
Результат	void

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

Converts coordinates for this element to those of a parent element. The ascendant does not need to be a direct parent

public localToAscendantCoordinates ( Element ascendant, Vector2 localCoords ) : Vector2
ascendant	Element	Ascendant.
localCoords	Vector2	Local coords.
Результат	Vector2

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

Transforms the specified point in the element's coordinates to be in the parent's coordinates.

public localToParentCoordinates ( Vector2 localCoords ) : Vector2
localCoords	Vector2	Local coords.
Результат	Vector2

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

Transforms the specified point in the element's coordinates to be in the stage's coordinates

public localToStageCoordinates ( Vector2 localCoords ) : Vector2
localCoords	Vector2	Local coords.
Результат	Vector2

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

Add x and y to current position

public moveBy ( float x, float y ) : void
x	float	The x coordinate.
y	float	The y coordinate.
Результат	void

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

public pack ( ) : void
Результат	void

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

Converts the coordinates given in the parent's coordinate system to this element's coordinate system.

public parentToLocalCoordinates ( Vector2 parentCoords ) : Vector2
parentCoords	Vector2	Parent coords.
Результат	Vector2

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

protected positionChanged ( ) : void
Результат	void

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

Removes this element from its parent, if it has a parent

public remove ( ) : bool
Результат	bool

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

Adds the specified rotation to the current rotation

public rotateBy ( float amountInDegrees ) : void
amountInDegrees	float	Amount in degrees.
Результат	void

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

protected rotationChanged ( ) : void
Результат	void

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

Adds the specified scale to the current scale

public scaleBy ( float scale ) : void
scale	float	Scale.
Результат	void

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

Adds the specified scale to the current scale

public scaleBy ( float scaleX, float scaleY ) : void
scaleX	float	Scale x.
scaleY	float	Scale y.
Результат	void

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

Transforms the specified point in screen coordinates to the element's local coordinate system

public screenToLocalCoordinates ( Vector2 screenCoords ) : Vector2
screenCoords	Vector2	Screen coords.
Результат	Vector2

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

Sets the x, y, width, and height.

public setBounds ( float x, float y, float width, float height ) : void
x	float	The x coordinate.
y	float	The y coordinate.
width	float	Width.
height	float	Height.
Результат	void

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

public setColor ( Color color ) : void
color	Color
Результат	void

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

If true, {@link #debugDraw} will be called for this element

public setDebug ( bool enabled ) : void
enabled	bool	Enabled.
Результат	void

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

public setHeight ( float height ) : void
height	float
Результат	void

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

public setIsVisible ( bool visible ) : void
visible	bool
Результат	void

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

Sets the origin position which is relative to the element's bottom left corner

public setOrigin ( float originX, float originY ) : void
originX	float	Origin x.
originY	float	Origin y.
Результат	void

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

Sets the origin position to the specified {@link Align alignment}.

public setOrigin ( int alignment ) : void
alignment	int	Alignment.
Результат	void

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

public setOriginX ( float originX ) : void
originX	float
Результат	void

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

public setOriginY ( float originY ) : void
originY	float
Результат	void

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

Sets the position of the element's bottom left corner

public setPosition ( float x, float y ) : Element
x	float	The x coordinate.
y	float	The y coordinate.
Результат	Element

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

Sets the position using the specified {@link Align alignment}. Note this may set the position to non-integer coordinates

public setPosition ( float x, float y, int alignment ) : void
x	float	The x coordinate.
y	float	The y coordinate.
alignment	int	Alignment.
Результат	void

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

public setRotation ( float degrees ) : void
degrees	float
Результат	void

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

Sets the scale for both X and Y

public setScale ( float scaleXY ) : void
scaleXY	float	Scale X.
Результат	void

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

Sets the scale X and scale Y

public setScale ( float scaleX, float scaleY ) : void
scaleX	float	Scale x.
scaleY	float	Scale y.
Результат	void

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

public setScaleX ( float scaleX ) : void
scaleX	float
Результат	void

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

public setScaleY ( float scaleY ) : void
scaleY	float
Результат	void

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

public setSize ( float width, float height ) : void
width	float
height	float
Результат	void

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

Determines how touch events are distributed to this element. Default is {@link Touchable#enabled}.

public setTouchable ( Touchable touchable ) : void
touchable	Touchable	Touchable.
Результат	void

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

If false, the element will not be drawn and will not receive touch events. Default is true.

public setVisible ( bool visible ) : void
visible	bool	Visible.
Результат	void

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

public setWidth ( float width ) : void
width	float
Результат	void

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

public setX ( float x ) : Element
x	float
Результат	Element

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

public setY ( float y ) : Element
y	float
Результат	Element

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

Sets the z-index of this element. The z-index is the index into the parent's {@link Group#getChildren() children}, where a lower index is below a higher index. Setting a z-index higher than the number of children will move the child to the front. Setting a z-index less than zero is invalid.

public setZIndex ( int index ) : void
index	int	Index.
Результат	void

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

protected sizeChanged ( ) : void
Результат	void

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

Transforms the specified point in the stage's coordinates to the element's local coordinate system.

public stageToLocalCoordinates ( Vector2 stageCoords ) : Vector2
stageCoords	Vector2	Stage coords.
Результат	Vector2

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

Changes the z-order for this element so it is in back of all siblings

public toBack ( ) : void
Результат	void

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

Changes the z-order for this element so it is in front of all siblings

public toFront ( ) : void
Результат	void

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

public validate ( ) : void
Результат	void

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

_debug защищенное свойство

protected bool _debug
Результат	bool

_layoutEnabled защищенное свойство

protected bool _layoutEnabled
Результат	bool

_needsLayout защищенное свойство

protected bool _needsLayout
Результат	bool

_visible защищенное свойство

protected bool _visible
Результат	bool

originX защищенное свойство

protected float originX
Результат	float

rotation защищенное свойство

protected float rotation
Результат	float

scaleX защищенное свойство

protected float scaleX
Результат	float

stage защищенное свойство

protected Stage stage
Результат	Stage

touchable защищенное свойство

protected Touchable touchable
Результат	Touchable