Action Class Reference
Action Class Reference
#include <interface.h>
Class Description
This class represents an action which can be triggered by the user.
The action with it's current name will appear in the hotkey dialog, where users can change the hotkey for the action. When the users press the hotkey, the OnActivate function will be called for the object.
Definition at line 539 of file interface.h.
Inheritance diagram for Action:
Public Member Functions | |
| Action (void) | |
| ~Action (void) | |
| virtual int | DefaultHotkey (void) const |
| This function should return the default hotkey for the action, which can be a combination of more than one values. More... | |
| virtual bool | IsSticky (void) const |
| Returns true if the action is sticky, i.e. can be activated independently from other actions. More... | |
| virtual bool | IsHidden (void) const |
| Returns true if the action is hide in hotkey dialog, i.e. only add the action in Marking Menus. More... | |
| virtual bool | IsEnabled (void) const |
| Returns true if the action is enabled else false. More... | |
| virtual void | SetEnabled (bool bEnabled) |
| Set the enable status. More... | |
| virtual void | OnActivate (bool bRepeat) |
| This function is called when the action is activated, i.e. when the user pressed the hotkey. More... | |
| virtual void | OnDeactivate (void) |
| Called when the action is deactivated, i.e. the user released the hotkey. More... | |
| virtual void | OnCursorMove (float fXPosition, float fYPosition, float fXChange, float fYChange) |
| Called when the cursor is moved by the user while the action is active. More... | |
| virtual void | OnOptions (void) |
| Called when the user requested to set options for this action. More... | |
| Public Member Functions inherited from Node | |
| Node (const QString &sStringID="", const QString &sDisplayName="") | |
| Standard constructor. More... | |
| virtual | ~Node (void) |
| virtual void | Initialize (void) |
| void | LoadTemplate (const QString &sFileName="", bool bStartEvent=false) |
| Use an external XML file to initialize the attributes. More... | |
| void | SaveTemplate (const QString &sFileName="", bool bSaveOnlyVisible=false) |
| Save current attributes as an XML template. More... | |
| unsigned int | Version (void) const |
| Returns the current version of the node. This number increases when the content of the node changed (when ContentChanged() called). More... | |
| void | SetVersion (unsigned int iVersion) |
| Sets the current version number for the node. More... | |
| unsigned int | ReferenceCount (void) const |
| Returns the number of pointers referencing this node. More... | |
| Attribute * | ReferencePointer (unsigned int iIndex) const |
| Returns the address of an attribute which refers to this node. The type of the attribute is always aptr. More... | |
| Node * | ReferenceNode (unsigned int iIndex) const |
| Returns the address of a node referencing this node. More... | |
| virtual QString | Name (const ClassDesc *pClass=0) const |
| Deprecated. More... | |
| virtual void | SetName (const QString &sName) |
| Deprecated. More... | |
| virtual QString | StringID (const ClassDesc *pClass=0) const |
| Returns the string id of the node. More... | |
| virtual void | SetStringID (const QString &sStringID) |
| Sets the string id of the node. More... | |
| virtual QString | DisplayName (void) const |
| Returns the display name of the node. More... | |
| virtual void | SetDisplayName (const QString &sDisplayName) |
| Sets the display name of the node. More... | |
| virtual QString | HelpID (void) const |
| Returns the help entry id of the node. Can be overwritten in derived classes. More... | |
| virtual void | SetHelpID (const QString &sHelpID) |
| Sets the help entry id of the node. More... | |
| void | Annex (Node *pSource, const QString &sCategory="") |
| Relink all the attributes of the source node to this one. More... | |
| virtual void | Serialize (Stream &s) |
| Serializes the node. More... | |
| bool | IsKindOf (const ClassDesc *pClass) const |
| Returns true if this node is derived from the pClass class. More... | |
| void | ContentChanged (void) const |
| This function must be called if the content of the node is changed. More... | |
| virtual void | CheckValidity (DiagnosticLevel iLevel=dgnLevel2) const |
| Checks the validity of this node. More... | |
| virtual void | CopyTo (Node *pNode) const |
| virtual Node * | Duplicate (void) const |
| virtual void | OnNodeEvent (const Attribute &cAttribute, NodeEventType cType) |
| This function is called if an event occurs with any of the attributes of the node. More... | |
| virtual void | OnEvent (const EventGate &cEvent) |
| This function is called when a generic event occurs. See EventGate class. More... | |
| void | RequestDeferredEvent (Attribute &cAttribute) |
| Request for a deferred event, which will occur only in the main loop. More... | |
| unsigned int | AttributeCount (void) const |
| Returns the number of attributes owned by the node. More... | |
| Attribute * | AttributeByIndex (int iIndex) const |
| Returns a specified attribute (or 0 if iIndex is greater than the number of attributes). More... | |
| Attribute * | AttributeByName (const QString &sName) const |
| Returns a specified attribute by its name. Returns 0 if the attribute not found. More... | |
| Attribute * | AttributeByID (const QString &sID) const |
| Returns a specified attribute by its ID. Returns 0 if the attribute not found. More... | |
| void | SetAttributeValue (const QString &sAttributeID, const QString &sNewValue) |
| Set the value of an attribute from a string. More... | |
| QString | AttributeValue (const QString &sAttributeID) const |
| Returns the current value of an attribute as a string. More... | |
| void | LogAttributes (void) const |
| Write all attributes into the log file. More... | |
| virtual QWidget * | CreatePropertiesWindow (QWidget *pParent) |
| Create a window which displays the attributes of the node. Can be overriden to provide a custom interface. More... | |
| Attribute * | AddAttribute (Attribute::AttributeType type, const QString &id) |
| Allows SDK users to add attributes at runtime. More... | |
| Node * | Next (void) const |
| Returns the next node in the chain. Used to enumerate the current nodes. See also First(). More... | |
| int | ID (void) const |
| Returns an ID for the node. The ID is unique in the whole application life. More... | |
| bool | SetID (int iID) |
| Set ID for the node. More... | |
Additional Inherited Members | |
| Public Types inherited from Node | |
| enum | DiagnosticLevel { dgnLevel1, dgnLevel2, dgnLevel3 } |
| Indicates the level of validity checking that is performed in CheckValidity() More... | |
| Static Public Member Functions inherited from Node | |
| static void | StartHashing () |
| This is called once in main once static ctors are done. More... | |
| static Node * | First (void) |
| This function will return the first node in the memory. Used to enumerate all the current nodes. See also Next(). More... | |
| static Node * | ByID (int iID) |
| Returns the node with the specified ID, or zero if such a node does not exists. More... | |
| static Node * | ByName (const QString &sClass, const QString &sName) |
| Search for a node with the name sName. More... | |
| Public Attributes inherited from Node | |
| AttributeThisPointer | m_pThis |
| DECLARE_CLASS | |
Constructor & Destructor Documentation
Member Function Documentation
This function should return the default hotkey for the action, which can be a combination of more than one values.
For example: keyCtrl+'J'
|
virtual |
Returns true if the action is sticky, i.e. can be activated independently from other actions.
|
virtual |
Returns true if the action is hide in hotkey dialog, i.e. only add the action in Marking Menus.
|
virtual |
Returns true if the action is enabled else false.
|
virtual |
Set the enable status.
|
virtual |
This function is called when the action is activated, i.e. when the user pressed the hotkey.
- Parameters
-
[in] bRepeat True if the Activation is not the initial, but is a result of a repeated keypress.
Called when the action is deactivated, i.e. the user released the hotkey.
|
virtual |
Called when the cursor is moved by the user while the action is active.
- Parameters
-
[in] fXPosition Horizontal position of the cursor on the screen, between 0-1 (0 means the very left) [in] fYPosition Vertical position of the cursor on the screen, between 0-1 (0 means top of the screen) [in] fXChange Horizontal change of the cursor position. [in] fYChange Vertical change of the cursor position.
Called when the user requested to set options for this action.
The documentation for this class was generated from the following file:
- Mudbox/interface.h