The Button node class. More...

#include "murl_graph_button.h"

Inheritance diagram for Murl::Graph::Button:

Additional Inherited Members

- Public Types inherited from Murl::IFactoryObject< INode >
typedef Array< const ClassInfo *> ClassInfoArray
 Definition of an array of ClassInfo objects. More...
 
- Public Member Functions inherited from Murl::IFactoryObject< INode >
virtual ~IFactoryObject ()
 The destructor. More...
 
virtual const ClassInfo * GetObjectClassInfo () const=0
 Get the object instance's class info, if present. More...
 
virtual void ResetObjectProperties ()=0
 Reset the object instance's properties to their default values.
 
- Static Public Member Functions inherited from Murl::IFactoryObject< INode >
static const PropertyInfoGetPropertyInfo ()
 Get the class' property info struct. More...
 
static const AttributeInfoGetAttributeInfo ()
 Get the class' attribute info struct. More...
 
static void ResetProperties (IFactoryObject< INode > *object)
 Reset an object instance's properties to their default values. More...
 

Detailed Description

The Button node class.

XML Elements

XML Graph Node Tag:

<Button>

XML Graph Node Attributes:

enabled="true" [Bool]

If true, the button reacts to input events. See Murl::Graph::IButton::SetEnabled().

activeFaces="FRONT_ONLY" [IEnums::PolygonFaces]

Selects which faces of the button are active (front-facing, back-facing or both). See Murl::Graph::IButton::SetActiveFaces().

upStateNodeId="" [String]

The ID of the node that is active when the button is in the "up" state. See Murl::Graph::IButton::SetStateNodeId().

downStateNodeId="" [String]

The ID of the node that is active when the button is in the "down" state. See Murl::Graph::IButton::SetStateNodeId().

hoverStateNodeId="" [String]

The ID of the node that is active when the button is in the "hover" state. See Murl::Graph::IButton::SetStateNodeId().

disabledStateNodeId="" [String]

The ID of the node that is active when the button is in the "disabled" state. See Murl::Graph::IButton::SetStateNodeId().

upStateChildIndex="-1" [SInt32]

The index of the child that is active when the button is in the "up" state. See Murl::Graph::IButton::SetStateChildIndex().

downStateChildIndex="-1" [SInt32]

The index of the child that is active when the button is in the "down" state. See Murl::Graph::IButton::SetStateChildIndex().

hoverStateChildIndex="-1" [SInt32]

The index of the child that is active when the button is in the "hover" state. See Murl::Graph::IButton::SetStateChildIndex().

disabledStateChildIndex="-1" [SInt32]

The index of the child that is active when the button is in the "disabled" state. See Murl::Graph::IButton::SetStateChildIndex().

timelineId="" [String]

The ID of the timeline node. Only needed if a timeline is used to visualize state changes. See Murl::Graph::IButton::SetTimelineNodeId().

timelineIndex="-1" [SInt32]

The child index of the timeline node. Only needed if a timeline is used to visualize state changes. See Murl::Graph::IButton::SetTimelineChildIndex().

upStateTime="0.0" [Real]

The timeline value when the button is in the "up" state. See Murl::Graph::IButton::SetStateAnimationTime().

downStateTime="0.0" [Real]

The timeline value when the button is in the "down" state. See Murl::Graph::IButton::SetStateAnimationTime().

hoverStateTime="0.0" [Real]

The timeline value when the button is in the "hover" state. See Murl::Graph::IButton::SetStateAnimationTime().

disabledStateTime="0.0" [Real]

The timeline value when the button is in the "disabled" state. See Murl::Graph::IButton::SetStateAnimationTime().

sizeX="1.0" [Real]

The virtual width of the button. See Murl::Graph::IScalable::SetScaleFactorX().

sizeY="1.0" [Real]

The virtual height of the button. See Murl::Graph::IScalable::SetScaleFactorY().

shape="RECTANGLE" [IEnums::TouchAreaShape]

The shape of the button. See Murl::Graph::IButton::SetShape().

containerAlignmentX="CENTER" [IEnums::AlignmentX]

The horizontal alignment of the virtual layout container. See Murl::Graph::IButton::SetContainerAlignmentX().

containerAlignmentY="CENTER" [IEnums::AlignmentY]

The vertical alignment of the virtual layout container. See Murl::Graph::IButton::SetContainerAlignmentY().

border="0.0" [Real]

The horizontal and vertical alignment borders. See Murl::Graph::IButton::SetBorder().

borderX="0.0" [Real]

The horizontal alignment border. See Murl::Graph::IButton::SetBorderX().

borderY="0.0" [Real]

The vertical alignment border. See Murl::Graph::IButton::SetBorderY().

outCoordSize="1.0" [Real]

The output range factor for both X and Y. See Murl::Graph::IButton::SetOutCoordSize().

outCoordSizeX="1.0" [Real]

The horizontal output range factor. See Murl::Graph::IButton::SetOutCoordSizeX().

outCoordSizeY="1.0" [Real]

The vertical output range factor. See Murl::Graph::IButton::SetOutCoordSizeY().

outCoordX1="-1.0" [Real]

The horizontal start coordinate of the output range. See Murl::Graph::IButton::SetOutCoord().

outCoordY1="1.0" [Real]

The vertical start coordinate of the output range. See Murl::Graph::IButton::SetOutCoord().

outCoordX2="1.0" [Real]

The horizontal end coordinate of the output range. See Murl::Graph::IButton::SetOutCoord().

outCoordY2="-1.0" [Real]

The vertical end coordinate of the output range. See Murl::Graph::IButton::SetOutCoord().

mouseButton="LEFT" [IEnums::MouseButton]

The mouse button generating events. See Murl::Graph::IButton::SetResponseButton().

passEvents="false" [Bool]

Pass events through underlying buttons. See Murl::Graph::IButton::SetPassEventsEnabled().

maxNumberOfEvents="0xffffffff" [UInt32]

The maximum number of simultaneously allowed touch events. See Murl::Graph::IButton::SetMaxNumberOfEvents().

frameBufferId="" [String]

The ID of an optional frame buffer to delegate input events to. See Murl::Graph::IButton::GetFrameBufferNodeTarget().

XML Animation Resource Tags:

<ScalingKey interpolation="LINEAR"> [ScalingKey]

The animation key acting on Murl::Graph::IScalable::SetScaleFactor().


The documentation for this class was generated from the following file:
  • murl_graph_button.h


Copyright © 2011-2018 Spraylight GmbH.