Public Member Functions |
| ScrollBar (Context *context) |
| Construct.
|
virtual | ~ScrollBar () |
| Destruct.
|
virtual void | ApplyAttributes () |
| Apply attribute changes that can not be applied immediately.
|
virtual void | OnResize () |
| React to resize.
|
void | SetOrientation (Orientation orientation) |
| Set orientation type.
|
void | SetRange (float range) |
| Set slider range maximum value (minimum value is always 0.)
|
void | SetValue (float value) |
| Set slider current value.
|
void | ChangeValue (float delta) |
| Change slider current value by a delta.
|
void | SetScrollStep (float step) |
| Set button scroll step.
|
void | SetStepFactor (float factor) |
| Set button step factor, can be used to adjust the step for constant pixel size.
|
void | StepBack () |
| Scroll back one step.
|
void | StepForward () |
| Scroll forward one step.
|
Orientation | GetOrientation () const |
| Return scrollbar orientation.
|
float | GetRange () const |
| Return slider range.
|
float | GetValue () const |
| Return slider current value.
|
float | GetScrollStep () const |
| Return button scroll step.
|
float | GetStepFactor () const |
| Return button step factor.
|
float | GetEffectiveScrollStep () const |
| Return scroll step multiplied by factor.
|
Button * | GetBackButton () const |
| Return back button element.
|
Button * | GetForwardButton () const |
| Return forward button element.
|
Slider * | GetSlider () const |
| Return slider element.
|
| UIElement (Context *context) |
| Construct.
|
virtual | ~UIElement () |
| Destruct.
|
virtual bool | LoadXML (const XMLElement &source) |
| Load from XML data. Return true if successful.
|
virtual bool | LoadXML (const XMLElement &source, XMLFile *styleFile) |
| Load from XML data with style. Return true if successful.
|
virtual bool | SaveXML (XMLElement &dest) |
| Save as XML data. Return true if successful.
|
virtual void | Update (float timeStep) |
| Perform UI element update.
|
virtual void | GetBatches (PODVector< UIBatch > &batches, PODVector< UIQuad > &quads, const IntRect ¤tScissor) |
| Return UI rendering batches.
|
virtual void | OnHover (const IntVector2 &position, const IntVector2 &screenPosition, int buttons, int qualifiers, Cursor *cursor) |
| React to mouse hover.
|
virtual void | OnClick (const IntVector2 &position, const IntVector2 &screenPosition, int buttons, int qualifiers, Cursor *cursor) |
| React to mouse click.
|
virtual void | OnDragBegin (const IntVector2 &position, const IntVector2 &screenPosition, int buttons, int qualifiers, Cursor *cursor) |
| React to mouse drag begin.
|
virtual void | OnDragMove (const IntVector2 &position, const IntVector2 &screenPosition, int buttons, int qualifiers, Cursor *cursor) |
| React to mouse drag motion.
|
virtual void | OnDragEnd (const IntVector2 &position, const IntVector2 &screenPosition, Cursor *cursor) |
| React to mouse drag end.
|
virtual bool | OnDragDropTest (UIElement *source) |
| React to drag and drop test. Return true to signal that the drop is acceptable.
|
virtual bool | OnDragDropFinish (UIElement *source) |
| React to drag and drop finish. Return true to signal that the drop was accepted.
|
virtual void | OnWheel (int delta, int buttons, int qualifiers) |
| React to mouse wheel.
|
virtual void | OnKey (int key, int buttons, int qualifiers) |
| React to a key press.
|
virtual void | OnChar (unsigned c, int buttons, int qualifiers) |
| React to a key press translated to a character.
|
bool | LoadXML (Deserializer &source) |
| Load from an XML file. Return true if successful.
|
bool | SaveXML (Serializer &dest) |
| Save to an XML file. Return true if successful.
|
void | SetName (const String &name) |
| Set name.
|
void | SetPosition (const IntVector2 &position) |
| Set position.
|
void | SetPosition (int x, int y) |
| Set position.
|
void | SetSize (const IntVector2 &size) |
| Set size.
|
void | SetSize (int width, int height) |
| Set size.
|
void | SetWidth (int width) |
| Set width only.
|
void | SetHeight (int height) |
| Set height only.
|
void | SetMinSize (const IntVector2 &minSize) |
| Set minimum size.
|
void | SetMinSize (int width, int height) |
| Set minimum size.
|
void | SetMinWidth (int width) |
| Set minimum width.
|
void | SetMinHeight (int height) |
| Set minimum height.
|
void | SetMaxSize (const IntVector2 &maxSize) |
| Set maximum size.
|
void | SetMaxSize (int width, int height) |
| Set maximum size.
|
void | SetMaxWidth (int width) |
| Set maximum width.
|
void | SetMaxHeight (int height) |
| Set maximum height.
|
void | SetFixedSize (const IntVector2 &size) |
| Set fixed size.
|
void | SetFixedSize (int width, int height) |
| Set fixed size.
|
void | SetFixedWidth (int width) |
| Set fixed width.
|
void | SetFixedHeight (int height) |
| Set fixed height.
|
void | SetAlignment (HorizontalAlignment hAlign, VerticalAlignment vAlign) |
| Set horizontal and vertical alignment.
|
void | SetHorizontalAlignment (HorizontalAlignment align) |
| Set horizontal alignment.
|
void | SetVerticalAlignment (VerticalAlignment align) |
| Set vertical alignment.
|
void | SetClipBorder (const IntRect &rect) |
| Set child element clipping border.
|
void | SetColor (const Color &color) |
| Set color on all corners.
|
void | SetColor (Corner corner, const Color &color) |
| Set color on one corner.
|
void | SetPriority (int priority) |
| Set priority.
|
void | SetOpacity (float opacity) |
| Set opacity.
|
void | SetBringToFront (bool enable) |
| Set whether should be brought to front when focused.
|
void | SetBringToBack (bool enable) |
| Set whether should be put to background when another element is focused.
|
void | SetClipChildren (bool enable) |
| Set whether should clip child elements. Default false.
|
void | SetSortChildren (bool enable) |
| Set whether should sort child elements according to priority. Default true.
|
void | SetActive (bool enable) |
| Set whether reacts to input.
|
void | SetFocus (bool enable) |
| Set whether is focused. Only one element can be focused at a time.
|
void | SetSelected (bool enable) |
| Set selected mode. Actual meaning is element dependent, for example constant hover or pressed effect.
|
void | SetVisible (bool enable) |
| Set whether is visible.
|
void | SetFocusMode (FocusMode mode) |
| Set focus mode.
|
void | SetDragDropMode (unsigned mode) |
| Set drag and drop flags.
|
void | SetStyle (XMLFile *file, const String &typeName) |
| Set style from an XML file. Find the style element by name.
|
void | SetStyle (const XMLElement &element) |
| Set style from an XML element.
|
void | SetStyleAuto (XMLFile *file) |
| Set style from an XML file. Find the style element automatically.
|
void | SetLayout (LayoutMode mode, int spacing=0, const IntRect &border=IntRect::ZERO) |
| Set layout.
|
void | SetLayoutMode (LayoutMode mode) |
| Set layout mode only.
|
void | SetLayoutSpacing (int spacing) |
| Set layout spacing.
|
void | SetLayoutBorder (const IntRect &border) |
| Set layout border.
|
void | UpdateLayout () |
| Manually update layout. Should not be necessary in most cases, but is provided for completeness.
|
void | DisableLayoutUpdate () |
| Disable automatic layout update. Should only be used if there are performance problems.
|
void | EnableLayoutUpdate () |
| Enable automatic layout update.
|
void | BringToFront () |
| Bring UI element to front.
|
UIElement * | CreateChild (ShortStringHash type, const String &name=String()) |
| Create and add a child element and return it.
|
void | AddChild (UIElement *element) |
| Add a child element.
|
void | InsertChild (unsigned index, UIElement *element) |
| Insert a child element into a specific position in the child list.
|
void | RemoveChild (UIElement *element, unsigned index=0) |
| Remove a child element. Starting search at specified index if provided.
|
void | RemoveAllChildren () |
| Remove all child elements.
|
void | Remove () |
| Remove from the parent element. If no other shared pointer references exist, causes immediate deletion.
|
void | SetParent (UIElement *parent) |
| Set parent element. Same as parent->AddChild(this).
|
void | SetVar (ShortStringHash key, const Variant &value) |
| Set a user variable.
|
void | SetInternal (bool enable) |
| Mark as internally (programmatically) created. Used when an element composes itself out of child elements.
|
template<class T > |
T * | CreateChild (const String &name=String()) |
| Template version of creating a child element.
|
const String & | GetName () const |
| Return name.
|
const IntVector2 & | GetPosition () const |
| Return position.
|
IntVector2 | GetScreenPosition () const |
| Return screen position.
|
const IntVector2 & | GetSize () const |
| Return size.
|
int | GetWidth () const |
| Return width.
|
int | GetHeight () const |
| Return height.
|
const IntVector2 & | GetMinSize () const |
| Return minimum size.
|
int | GetMinWidth () const |
| Return minimum width.
|
int | GetMinHeight () const |
| Return minimum height.
|
const IntVector2 & | GetMaxSize () const |
| Return maximum size.
|
int | GetMaxWidth () const |
| Return minimum width.
|
int | GetMaxHeight () const |
| Return minimum height.
|
const IntVector2 & | GetChildOffset () const |
| Return child element offset.
|
HorizontalAlignment | GetHorizontalAlignment () const |
| Return horizontal alignment.
|
VerticalAlignment | GetVerticalAlignment () const |
| Return vertical alignment.
|
const IntRect & | GetClipBorder () const |
| Return child element clipping border.
|
const Color & | GetColor (Corner corner) const |
| Return corner color.
|
int | GetPriority () const |
| Return priority.
|
float | GetOpacity () const |
| Return opacity.
|
float | GetDerivedOpacity () const |
| Return derived opacity (affected by parent elements.)
|
bool | GetBringToFront () const |
| Return whether should be brought to front when focused.
|
bool | GetBringToBack () const |
| Return whether should be put to background when another element is focused.
|
bool | GetClipChildren () const |
| Return whether should clip child elements.
|
bool | GetSortChildren () const |
| Return whether should sort child elements according to priority.
|
bool | HasFocus () const |
| Return whether has focus.
|
bool | IsActive () const |
| Return whether reacts to input.
|
bool | IsSelected () const |
| Return whether is selected. Actual meaning is element dependent.
|
bool | IsVisible () const |
| Return whether is visible.
|
bool | IsHovering () const |
| Return whether the cursor is hovering on this element.
|
bool | IsInternal () const |
| Return whether is internally created.
|
bool | HasColorGradient () const |
| Return whether has different color in at least one corner.
|
FocusMode | GetFocusMode () const |
| Return focus mode.
|
unsigned | GetDragDropMode () const |
| Return drag and drop flags.
|
LayoutMode | GetLayoutMode () const |
| Return layout mode.
|
int | GetLayoutSpacing () const |
| Return layout spacing.
|
const IntRect & | GetLayoutBorder () const |
| Return layout border.
|
unsigned | GetNumChildren (bool recursive=false) const |
| Return number of child elements.
|
UIElement * | GetChild (unsigned index) const |
| Return child element by index.
|
UIElement * | GetChild (const String &name, bool recursive=false) const |
| Return child element by name.
|
const Vector< SharedPtr
< UIElement > > & | GetChildren () const |
| Return immediate child elements.
|
void | GetChildren (PODVector< UIElement * > &dest, bool recursive=false) const |
| Return child elements either recursively or non-recursively.
|
UIElement * | GetParent () const |
| Return parent element.
|
UIElement * | GetRoot () const |
| Return root element.
|
const Color & | GetDerivedColor () const |
| Return derived color. Only valid when no gradient.
|
const Variant & | GetVar (ShortStringHash key) const |
| Return a user variable.
|
const VariantMap & | GetVars () const |
| Return all user variables.
|
IntVector2 | ScreenToElement (const IntVector2 &screenPosition) |
| Convert screen coordinates to element coordinates.
|
IntVector2 | ElementToScreen (const IntVector2 &position) |
| Convert element coordinates to screen coordinates.
|
bool | IsInside (IntVector2 position, bool isScreen) |
| Return whether a point (either in element or screen coordinates) is inside the element.
|
bool | IsInsideCombined (IntVector2 position, bool isScreen) |
| Return whether a point (either in element or screen coordinates) is inside the combined rect of the element and its children.
|
IntRect | GetCombinedScreenRect () |
| Return combined screen coordinate rect of element and its children.
|
void | SortChildren () |
| Sort child elements if sorting enabled and order dirty. Called by UI.
|
int | GetLayoutMinSize () const |
| Return minimum layout element size in the layout direction. Only valid after layout has been calculated.
|
void | SetChildOffset (const IntVector2 &offset) |
| Set child offset.
|
void | SetHovering (bool enable) |
| Set hovering state.
|
void | SetTempVisible (bool enable) |
| Set temporary visibility status without updating layout or sending events. Used internally.
|
void | AdjustScissor (IntRect ¤tScissor) |
| Adjust scissor for rendering.
|
void | GetBatchesWithOffset (IntVector2 &offset, PODVector< UIBatch > &batches, PODVector< UIQuad > &quads, IntRect currentScissor) |
| Get UI rendering batches with a specified offset. Also recurses to child elements.
|
| Serializable (Context *context) |
| Construct.
|
virtual | ~Serializable () |
| Destruct.
|
virtual void | OnSetAttribute (const AttributeInfo &attr, const Variant &src) |
| Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
|
virtual void | OnGetAttribute (const AttributeInfo &attr, Variant &dest) |
| Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
|
virtual bool | Load (Deserializer &source) |
| Load from binary data. Return true if successful.
|
virtual bool | Save (Serializer &dest) |
| Save as binary data. Return true if successful.
|
bool | SetAttribute (unsigned index, const Variant &value) |
| Set attribute by index. Return true if successfully set.
|
bool | SetAttribute (const String &name, const Variant &value) |
| Set attribute by name. Return true if successfully set.
|
void | AllocateNetworkState () |
| Allocate network attribute state.
|
void | WriteInitialDeltaUpdate (Serializer &dest) |
| Write initial delta network update.
|
void | WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits) |
| Write a delta network update according to dirty attribute bits.
|
void | WriteLatestDataUpdate (Serializer &dest) |
| Write a latest data network update.
|
void | ReadDeltaUpdate (Deserializer &source) |
| Read and apply a network delta update.
|
void | ReadLatestDataUpdate (Deserializer &source) |
| Read and apply a network latest data update.
|
Variant | GetAttribute (unsigned index) |
| Return attribute value by index. Return empty if illegal index.
|
Variant | GetAttribute (const String &name) |
| Return attribute value by name. Return empty if not found.
|
unsigned | GetNumAttributes () const |
| Return number of attributes.
|
unsigned | GetNumNetworkAttributes () const |
| Return number of network replication attributes.
|
const Vector< AttributeInfo > * | GetAttributes () const |
| Return attribute descriptions, or null if none defined.
|
const Vector< AttributeInfo > * | GetNetworkAttributes () const |
| Return network replication attribute descriptions, or null if none defined.
|
| Object (Context *context) |
| Construct.
|
virtual | ~Object () |
| Destruct. Clean up self from event sender & receiver structures.
|
virtual ShortStringHash | GetType () const =0 |
| Return type hash.
|
virtual const String & | GetTypeName () const =0 |
| Return type name.
|
virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event.
|
void | SubscribeToEvent (StringHash eventType, EventHandler *handler) |
| Subscribe to an event that can be sent by any sender.
|
void | SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler) |
| Subscribe to a specific sender's event.
|
void | UnsubscribeFromEvent (StringHash eventType) |
| Unsubscribe from an event.
|
void | UnsubscribeFromEvent (Object *sender, StringHash eventType) |
| Unsubscribe from a specific sender's event.
|
void | UnsubscribeFromEvents (Object *sender) |
| Unsubscribe from a specific sender's events.
|
void | UnsubscribeFromAllEvents () |
| Unsubscribe from all events.
|
void | UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData) |
| Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
|
void | SendEvent (StringHash eventType) |
| Send event to all subscribers.
|
void | SendEvent (StringHash eventType, VariantMap &eventData) |
| Send event with parameters to all subscribers.
|
Context * | GetContext () const |
| Return execution context.
|
Object * | GetSubsystem (ShortStringHash type) const |
| Return subsystem by type.
|
Object * | GetEventSender () const |
| Return active event sender. Null outside event handling.
|
EventHandler * | GetEventHandler () const |
| Return active event handler. Null outside event handling.
|
bool | HasSubscribedToEvent (StringHash eventType) const |
| Return whether has subscribed to an event without specific sender.
|
bool | HasSubscribedToEvent (Object *sender, StringHash eventType) const |
| Return whether has subscribed to a specific sender's event.
|
template<class T > |
T * | GetSubsystem () const |
| Template version of returning a subsystem.
|
| RefCounted () |
| Construct. Allocate the reference count structure and set an initial self weak reference.
|
virtual | ~RefCounted () |
| Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
|
void | AddRef () |
| Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
|
void | ReleaseRef () |
| Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
|
int | Refs () const |
| Return reference count.
|
int | WeakRefs () const |
| Return weak reference count.
|
RefCount * | RefCountPtr () |
| Return pointer to the reference count structure.
|