Entity Class

Create the entity.

Optional background entity that will not respond to events and will always be rendered right behind this entity.

Is the entity draggable (eg can a user grab it and drag it around).

Return the default size for this entity.

Entity fill color - this is just a sugarcoat to access the default fill color style property.

Get internal destination rect.

Get if this entity needs to recalculate destination rect.

Does this entity or one of its children currently focused?

Return if the mouse is currently pressing on this entity (eg over it and left mouse button is down).

Return if the mouse is currently over this entity (regardless of weather or not mouse button is down).

Entity fill color opacity - this is just a sugarcoat to access the default fill color alpha style property.

Entity outline color - this is just a sugarcoat to access the default outline color style property.

Entity outline color opacity - this is just a sugarcoat to access the default outline color alpha style property.

Entity outline width - this is just a sugarcoat to access the default outline color style property.

Entity padding - this is just a sugarcoat to access the default padding style property.

Get the direct parent of this entity.

Return entity priority in drawing order and event handling.

Entity scale - this is just a sugarcoat to access the default scale style property.

Entity shadow color - this is just a sugarcoat to access the default shadow color style property.

Entity shadow offset - this is just a sugarcoat to access the default shadow offset style property.

Entity shadow scale - this is just a sugarcoat to access the default shadow scale style property.

Entity current size property.

Extra space (in pixels) to reserve *after* this entity when using Auto Anchors.

Extra space (in pixels) to reserve *before* this entity when using Auto Anchors.

Current entity state (default / mouse hover / mouse down..).

Set / get visibility.

Add a child entity.

Bring this entity to be on front (inside its parent).

Calculate and return the destination rectangle, eg the space this entity is rendered on.

Calculate and return the internal destination rectangle (note: this relay on the dest rect having a valid value first).

Remove all children entities.

Draw this entity and its children.

Determines whether the specified object is equal to the current object.

Find and return first occurance of a child entity with a given identifier.

Find and return first occurance of a child entity with a given identifier and specific type.

Return stylesheet property for current entity state (or default if undefined for state).

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.

Return all children of this entity.

Serves as the default hash function.

Return the relative offset, in pixels, from parent top-left corner.

Return stylesheet property for a given state.

Gets the Type of the current instance.

Check if this entity is a descendant of another entity. This goes up all the way to root.

Return if this entity is currently disabled, due to self or one of the parents / grandparents being disabled.

Test if a given point is inside entity's boundaries.

Return if this entity is currently locked, due to self or one of the parents / grandparents being locked.

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.

Return if this entity is currently visible, eg this and all its parents and grandparents are visible.

Iterate over children and call 'callback' for every direct child of this entity.

Mark that this entity boundaries or style changed and it need to recalculate cached destination rect and other things.

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.

Remove child entity.

Remove this entity from its parent.

Set the anchor of this entity.

Set the offset of this entity.

Set the position and anchor of this entity.

Set a stylesheet property.

Returns a string that represents the current object.

Called every frame to update entity state and call events.

Update dest rect and internal dest rect. This is called internally whenever a change is made to the entity or its parent.

Update dest rect and internal dest rect, but only if needed (eg if something changed since last update).

Update the entire stylesheet from a different stylesheet.

Callback to execute every frame after this entity is rendered.

Callback to execute every frame after this entity updates.

Optional data you can attach to this entity and retrieve later (for example when handling events).

Callback to execute every frame before this entity is rendered.

Callback to execute every frame before this entity updates.

If this boolean is true, events will just "go through" this entity to its children or entities behind it. This bool comes to solve conditions where you have two panels without skin that hide each other but you want users to be able to click on the bottom panel through the upper panel, provided it doesn't hit any of the first panel's children.

Default size this entity will have when no size is provided or when -1 is set for either width or height.

Basic default style that all entities share. Note: loaded from UI theme xml file.

If true, this entity and its children will be drawn in greyscale effect and will not respond to events.

Adds extra space outside the dest rect for collision detection. In other words, if extra margin is set to 10 and the user points with its mouse 5 pixels above this entity, it would still think the user points on the entity.

Optional identifier you can attach to entities so you can later search and retrieve by.

If true, users will not be able to drag this entity outside its parent boundaries.

If true, this entity and its children will not respond to events (but will be drawn normally, unlike when disabled).

Callback to execute when user clicks on this entity (eg release mouse over it).

Callback to execute every time this entity focus / unfocus.

Callback to execute when mouse button is pressed over this entity (called once when button is pressed).

Callback to execute when mouse start hovering over this entity (eg enters its region).

Callback to execute when mouse stop hovering over this entity (eg leaves its region).

Callback to execute when mouse button is released over this entity (called once when button is released).

Callback to execute when mouse wheel scrolls and this entity is the active entity.

Called when entity starts getting dragged (only if draggable).

Called when entity stop getting dragged (only if draggable).

Callback to execute when entity value changes (relevant only for entities with value).

Callback to execute every time the visibility of this entity changes (also invokes when parent becomes invisible / visible again).

If in promiscuous mode, mouse button is pressed *outside* the entity and then released on the entity, click event will be fired. If false, in order to fire click event the mouse button must be pressed AND released over this entity (but can travel outside while being held down, as long as its released inside). Note: Windows default behavior is non promiscuous mode.

Optional tooltip text to show if the user points on this entity for long enough.

A special size used value to use when you want to get the entity default size.

If true (default), will use the actual object size for collision detection. If false, will use the size property. This is useful for paragraphs, for example, where the actual width is based on text content and can vary and be totally different than the size set in the constructor.

Called every frame while the entity is being dragged.

Callback to execute every frame while mouse button is pressed over the entity.

Callback to execute every frame while mouse is hovering over the entity.