GeonBit.UI Documentation
Entity Methods |
The Entity type exposes the following members.
![](SectionExpanded.png)
Name | Description | |
---|---|---|
![]() | AddChild |
Add a child entity.
|
![]() | BringToFront |
Bring this entity to be on front (inside its parent).
|
![]() | CalcDestRect |
Calculate and return the destination rectangle, eg the space this entity is rendered on.
|
![]() | CalcInternalRect |
Calculate and return the internal destination rectangle (note: this relay on the dest rect having a valid value first).
|
![]() | ClearChildren |
Remove all children entities.
|
![]() | Draw |
Draw this entity and its children.
|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | Find(String, Boolean) |
Find and return first occurance of a child entity with a given identifier.
|
![]() | FindT(String, Boolean) |
Find and return first occurance of a child entity with a given identifier and specific type.
|
![]() | GetActiveStyle |
Return stylesheet property for current entity state (or default if undefined for state).
|
![]() | GetActualDestRect |
Return actual destination rectangle.
This can be override and implemented by things like Paragraph, where the actual destination rect is based on
text content, font and word-wrap.
|
![]() | GetChildren |
Return all children of this entity.
|
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetRelativeOffset |
Return the relative offset, in pixels, from parent top-left corner.
|
![]() | GetStyleProperty |
Return stylesheet property for a given state.
|
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IsDeepChildOf |
Check if this entity is a descendant of another entity.
This goes up all the way to root.
|
![]() | IsDisabled |
Return if this entity is currently disabled, due to self or one of the parents / grandparents being disabled.
|
![]() | IsInsideEntity |
Test if a given point is inside entity's boundaries.
|
![]() | IsLocked |
Return if this entity is currently locked, due to self or one of the parents / grandparents being locked.
|
![]() | IsNaturallyInteractable |
Return true if this entity is naturally interactable, like buttons, lists, etc.
Entities that are not naturally interactable are things like paragraph, colored rectangle, icon, etc.
|
![]() | IsVisible |
Return if this entity is currently visible, eg this and all its parents and grandparents are visible.
|
![]() | IterateChildren |
Iterate over children and call 'callback' for every direct child of this entity.
|
![]() | MarkAsDirty |
Mark that this entity boundaries or style changed and it need to recalculate cached destination rect and other things.
|
![]() | PropagateEventsTo |
Propagate all events trigger by this entity to a given other entity.
For example, if "OnClick" will be called on this entity, it will trigger OnClick on 'other' as well.
|
![]() | RemoveChild |
Remove child entity.
|
![]() | RemoveFromParent |
Remove this entity from its parent.
|
![]() | SetAnchor |
Set the anchor of this entity.
|
![]() | SetOffset |
Set the offset of this entity.
|
![]() | SetPosition |
Set the position and anchor of this entity.
|
![]() | SetStyleProperty |
Set a stylesheet property.
|
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | Update |
Called every frame to update entity state and call events.
|
![]() | UpdateDestinationRects |
Update dest rect and internal dest rect.
This is called internally whenever a change is made to the entity or its parent.
|
![]() | UpdateDestinationRectsIfDirty |
Update dest rect and internal dest rect, but only if needed (eg if something changed since last update).
|
![]() | UpdateStyle |
Update the entire stylesheet from a different stylesheet.
|
![](SectionExpanded.png)