The ITouchArea graph node interface.
This interface represents an input object in world space (i.e. a "button").
A touch area by itself does not actually have any renderable geometry; instead, it only holds a specific surface shape on which any pointing events are evaluated in 3D space.
In general, a touch area can be in one of 3 available states: "Up", "Down" or "Disabled". For devices that provide a point input method other than a touch screen, such as a mouse, there also exists an additional "Hover" state. Internally, a touch area node acts similar to a Graph::ISwitch node, managing visibility of a subset of its child nodes that are assigned to these states. Depending on the actual state the touch area is in, the respective child node gets activated, and all other ones deactivated. If a child node is not assigned to one of these states, it is left unmanaged.
In addition, it is possible to define a single child node implementing the Graph::ITimeline interface to react on state changes. The assigned timeline will then be started to run up to a given time value set for that state.
|
virtual INode * | GetNodeInterface ()=0 |
| Get the mutable Graph::INode interface. More...
|
|
virtual const INode * | GetNodeInterface () const =0 |
| Get the constant Graph::INode interface. More...
|
|
virtual ITransform * | GetTransformInterface ()=0 |
| Get the mutable Graph::ITransform interface. More...
|
|
virtual const ITransform * | GetTransformInterface () const =0 |
| Get the constant Graph::ITransform interface. More...
|
|
virtual IFrameBufferNodeTarget * | GetFrameBufferNodeTarget ()=0 |
| Get the mutable IFrameBufferNodeTarget container. More...
|
|
virtual const IFrameBufferNodeTarget * | GetFrameBufferNodeTarget () const =0 |
| Get the constant IFrameBufferNodeTarget container. More...
|
|
virtual Bool | SetStateNodeId (IEnums::ButtonState state, const String &nodeId)=0 |
| Set the touch area's active node ID for a given state. More...
|
|
virtual const String & | GetStateNodeId (IEnums::ButtonState state) const =0 |
| Get the ID of the touch area's active node for a given state. More...
|
|
virtual Bool | SetStateChildIndex (IEnums::ButtonState state, SInt32 childIndex)=0 |
| Set the touch area's active child for a given state. More...
|
|
virtual SInt32 | GetStateChildIndex (IEnums::ButtonState state) const =0 |
| Get the index of the touch area's active child for a given state. More...
|
|
virtual Bool | SetStateAnimationTime (IEnums::ButtonState state, Real time)=0 |
| Set the target time value for a given state. More...
|
|
virtual Real | GetStateAnimationTime (IEnums::ButtonState state) const =0 |
| Get the target time value set for a given state. More...
|
|
virtual Bool | ResetStateAnimationTime (IEnums::ButtonState state)=0 |
| Reset the target time value for a given state to 0. More...
|
|
virtual Bool | IsStateAnimationTimeSet (IEnums::ButtonState state) const =0 |
| Query if a target time value was set for a given state. More...
|
|
virtual Bool | SetTimelineNodeId (const String &nodeId)=0 |
| Define a timeline node from within the current graph namespace. More...
|
|
virtual const String & | GetTimelineNodeId () const =0 |
| Query the node ID of an assigned timeline child. More...
|
|
virtual Bool | SetTimelineChildIndex (SInt32 nodeIndex)=0 |
| Define a timeline node among the touch area's children. More...
|
|
virtual SInt32 | GetTimelineChildIndex () const =0 |
| Query the child index of an assigned timeline child. More...
|
|
virtual Bool | SetEnabled (Bool enabled)=0 |
| Enable or disable the button. More...
|
|
virtual Bool | IsEnabled () const =0 |
| Check if the button is enabled. More...
|
|
virtual Bool | SetActiveFaces (IEnums::PolygonFaces faces)=0 |
| Set which faces of the button are active. More...
|
|
virtual IEnums::PolygonFaces | GetActiveFaces () const =0 |
| Check which faces of the button are active. More...
|
|
virtual Bool | SetOutCoordSize (Real sizeX, Real sizeY)=0 |
| Set the output coordinate reference size. More...
|
|
virtual Bool | SetOutCoordSizeX (Real sizeX)=0 |
| Set the horizontal output coordinate reference size. More...
|
|
virtual Bool | SetOutCoordSizeY (Real sizeY)=0 |
| Set the vertical output coordinate reference size. More...
|
|
virtual Real | GetOutCoordSizeX () const =0 |
| Get the horizontal output coordinate reference size. More...
|
|
virtual Real | GetOutCoordSizeY () const =0 |
| Get the vertical output coordinate reference size. More...
|
|
virtual Bool | SetOutCoord (Real x1, Real y1, Real x2, Real y2)=0 |
| Set the button's output coordinate range. More...
|
|
virtual Bool | SetOutCoord1 (Real x1, Real y1)=0 |
| Set the button's output coordinate start. More...
|
|
virtual Bool | SetOutCoord2 (Real x2, Real y2)=0 |
| Set the button's output coordinate end. More...
|
|
virtual Bool | SetOutCoordX1 (Real x1)=0 |
| Set the button's horizontal start output coordinate. More...
|
|
virtual Bool | SetOutCoordY1 (Real y1)=0 |
| Set the button's vertical start output coordinates. More...
|
|
virtual Bool | SetOutCoordX2 (Real x2)=0 |
| Set the button's horizontal end output coordinate. More...
|
|
virtual Bool | SetOutCoordY2 (Real y2)=0 |
| Set the button's vertical end output coordinates. More...
|
|
virtual Real | GetOutCoordX1 () const =0 |
| Get the button's horizontal start output coordinate. More...
|
|
virtual Real | GetOutCoordY1 () const =0 |
| Get the button's vertical start output coordinate. More...
|
|
virtual Real | GetOutCoordX2 () const =0 |
| Get the button's horizontal end output coordinate. More...
|
|
virtual Real | GetOutCoordY2 () const =0 |
| Get the button's vertical end output coordinate. More...
|
|
virtual Bool | SetOutCoordClippingEnabled (Bool enable)=0 |
| Enable or disable output coordinate clipping. More...
|
|
virtual Bool | IsOutCoordClippingEnabled () const =0 |
| Check if output coordinate clipping is enabled. More...
|
|
virtual Bool | SetResponseButton (IEnums::MouseButton button)=0 |
| Set the mouse button this button responds to. More...
|
|
virtual IEnums::MouseButton | GetResponseButton () const =0 |
| Get the mouse button this button responds to. More...
|
|
virtual Bool | SetPassEventsEnabled (Bool enable)=0 |
| Enable or disable event pass through. More...
|
|
virtual Bool | IsPassEventsEnabled () const =0 |
| Check event pass through is enabled. More...
|
|
virtual Bool | SetMaxNumberOfEvents (UInt32 value)=0 |
| Set the maximum number of simultaneous touch events. More...
|
|
virtual UInt32 | GetMaxNumberOfEvents () const =0 |
| Get the maximum number of simultaneous touch events. More...
|
|
virtual Bool | ResetEvents ()=0 |
| Reset the tracking of all current events. More...
|
|
virtual UInt32 | GetNumberOfActiveEvents () const =0 |
| Get the total number of active events. More...
|
|
virtual UInt32 | GetActiveEventId (UInt32 activeEventIndex) const =0 |
| Get the unique ID of a specific active event. More...
|
|
virtual UInt32 | GetNumberOfTrackedEvents () const =0 |
| Get the number of currently tracked events. More...
|
|
virtual UInt32 | GetTrackedEventId (UInt32 trackedEventIndex) const =0 |
| Get the unique ID of a specific tracked event. More...
|
|
virtual Bool | HasEventUpdate (UInt32 id) const =0 |
| Check if a given event has received updates from any input device during the most recent logic tick. More...
|
|
virtual IEnums::InputDeviceType | GetEventDeviceType (UInt32 id) const =0 |
| Get the type of input device that reported the event with a given ID. More...
|
|
virtual const Vector & | GetEventOutCoord (UInt32 id) const =0 |
| Get the output coordinate of an event with a given ID, in 2D space. More...
|
|
virtual const Vector & | GetLocalEventPosition (UInt32 id) const =0 |
| Get the position of an event with a given ID, in 3D object space. More...
|
|
virtual const Vector & | GetLocalEventDelta (UInt32 id) const =0 |
| Get the current position delta of an event with a given ID, in object space. More...
|
|
virtual Bool | IsEventTracked (UInt32 id) const =0 |
| Check if a given event is in the "tracked" state. More...
|
|
virtual Bool | IsEventInside (UInt32 id) const =0 |
| Check if a given event's incidence point is within the button's bounds. More...
|
|
virtual Bool | IsEventPressed (UInt32 id) const =0 |
| Check if a given event is in the pressed state. More...
|
|
virtual Bool | WasPressed () const =0 |
| Check if the button was pressed. More...
|
|
virtual Bool | WasReleasedInside () const =0 |
| Check if the button was released inside. More...
|
|
virtual Bool | WasReleasedOutside () const =0 |
| Check if the button was released outside. More...
|
|
virtual const Vector & | GetEventPosition () const =0 |
| Get the position of the current button event, in object space. More...
|
|
virtual IEnums::ButtonState | GetButtonState () const =0 |
| Get the current button state. More...
|
|