Behavior.Behavior Class Reference
#include <class_behavior_1_1_behavior.h>
Public Member Functions |
|
| __init__ () | |
| getTypeLabel () | |
| getThumbnailImage () | |
| setThumbnailImage () | |
| getLabel () | |
| setLabel () | |
| __eq__ () | |
| __ne__ () | |
| setOriginalModelId () | |
| getOriginalModelId () | |
| addParameter () | |
| Add new parameters to the behavior. |
|
| getParameterNames () | |
| Returns a list of all parameter names for
this behavior. |
|
| getParameterType () | |
| Returns the type of the parameter. |
|
| getParameterValue () | |
| Returns a value of a given parameter.
|
|
| setParameterValue () | |
| Sets the value of a given parameter.
|
|
| parameterCount () | |
| isRuntimeParameter () | |
| Return true if the specified parameter is a
"runtime-only" parameter. |
|
| setRuntimeParameter () | |
| Sets whether or not a parameter is
"runtime-only" or not. |
|
| initParameters () | |
| Virtual method, called after a behavior is
read from a scene file. |
|
| reset () | |
| getNodes () | |
| Returns a set of node ids that this behavior
is assigned to. |
|
| validateNodesSelection () | |
| Make it possible for a behavior to control
which selection it accepts, override and return false for
unacceptable selections. |
|
| setNodeDeletionCallback () | |
| setPlaybackStatusChangedCallback () | |
| onNodeDeleted () | |
| Removes the deleted node from this behavior.
|
|
| addNodes () | |
| Add nodes to this behaviour. |
|
| getRemoveNodesUndoMessages () | |
| Implement to allow behaviors to have custom
data that needs to be readded at undo of remove. |
|
| removeNodes () | |
| Remove the nodes from this behaviour.
|
|
| dirtyNodes () | |
| Call this method when the nodes of this
behaviour have been updated outside of this behaviour. |
|
| otherBehaviorRemoved () | |
| Since some behaviors can reference behaviors
they need to override this to clean up on remove. |
|
| toggleActive () | |
| activate () | |
| deactivate () | |
| setIsActive () | |
| isActive () | |
| setIsEnabled () | |
| isEnabled () | |
| getDuration () | |
| getDurationForExecutableAction () | |
| play () | |
| playBackward () | |
| step () | |
| update () | |
| Implement this method in subclasses to
perform the actual behavior. |
|
| ExecutableActions () | |
| ObjectExecutableActions () | |
| GetExecutableActionLabel () | |
| Return the label corresponding to the
specified action, if one has been defined, and the action
otherwise. |
|
| SpeedStandard () | |
| SpeedDouble () | |
| SpeedHalf () | |
| SpeedTen () | |
| SpeedTenth () | |
| PlayFromStart () | |
| PlayFromEnd () | |
| Pause () | |
| Continue () | |
| StopAndResetToStart () | |
| StopAndResetToEnd () | |
| ContinueForward () | |
| ContinueBackward () | |
| preRead () | |
| read () | |
| postRead () | |
| preWrite () | |
| Write () | |
| postWrite () | |
| basename () | |
| Return a basename that will be used to build
names and labels. |
|
Public Attributes |
|
| string | kLabel = "Label" |
| string | kNodes = "Nodes" |
| string | kNodesList = "NodesList" |
| string | kThumbnail = "Thumbnail" |
| string | kDirection = "Direction" |
| string | kStartDirection = "StartDirection" |
| int | kDirectionValueForward = 1 |
| int | kDirectionValueBackward = 1 |
| kDefaultDirection = kDirectionValueForward | |
| string | kActivatedType = "ActivatedType" |
| string | kActivatedId = "ActivatedId" |
| string | kActivatedCommand = "ActivatedCommand" |
| string | kFloatTuple = "Floats" |
| string | kStringTuple = "Strings" |
| string | kStringSet = "StringSet" |
| string | kAffineMatrix = "AffineMatrix" |
| string | kFile = "Filename" |
| int | kThumbnailResolutionX = 64 |
| int | kThumbnailResolutionY = 64 |
| kPropContainsNodes = True | |
| kPropExclusiveNodes = True | |
| kPropIgnoreSelected = False | |
| kAllowConflictNodes = True | |
Member Function Documentation
| Behavior.Behavior.__init__ | ( | ) |
Reimplemented from Loadable.Loadable.
Reimplemented in FbxBehavior.FbxBehavior, KeyframeAnimation.KeyframeAnimation, MasterBehavior.MasterBehavior, PercentageBehavior.PercentageBehavior, RotateAboutAxis.RotateAboutAxis, RotateTranslate.RotateTranslate, ShowHide.ShowHide, TransformBehavior.TransformBehavior, Translate.Translate, TriggerBehavior.TriggerBehavior, TurnTable.TurnTable, TurnTableBehavior.TurnTableBehavior, and VisibilitySwitch.VisibilitySwitch.
| Behavior.Behavior.getTypeLabel | ( | ) |
| Behavior.Behavior.getThumbnailImage | ( | ) |
| Behavior.Behavior.setThumbnailImage | ( | ) |
| Behavior.Behavior.getLabel | ( | ) |
| Behavior.Behavior.setLabel | ( | ) |
| Behavior.Behavior.__eq__ | ( | ) |
Reimplemented from Loadable.Loadable.
| Behavior.Behavior.__ne__ | ( | ) |
Reimplemented from Loadable.Loadable.
| Behavior.Behavior.setOriginalModelId | ( | ) |
Reimplemented in FbxBehavior.FbxBehavior.
| Behavior.Behavior.getOriginalModelId | ( | ) |
Reimplemented in FbxBehavior.FbxBehavior.
| Behavior.Behavior.addParameter | ( | ) |
Add new parameters to the behavior.
This method should be called when the class is initialized.
| Behavior.Behavior.getParameterNames | ( | ) |
Returns a list of all parameter names for this behavior.
| Behavior.Behavior.getParameterType | ( | ) |
Returns the type of the parameter.
The subclasses may need to override this method to provide the types of parameters that do not have standard types (3Floats, ... ).
Reimplemented in FbxBehavior.FbxBehavior, PercentageBehavior.PercentageBehavior, RotateAboutAxis.RotateAboutAxis, RotateTranslate.RotateTranslate, TransformBehavior.TransformBehavior, Translate.Translate, TurnTable.TurnTable, TurnTableBehavior.TurnTableBehavior, and VisibilitySwitch.VisibilitySwitch.
| Behavior.Behavior.getParameterValue | ( | ) |
Returns a value of a given parameter.
| Behavior.Behavior.setParameterValue | ( | ) |
Sets the value of a given parameter.
Reimplemented in FbxBehavior.FbxBehavior, KeyframeAnimation.KeyframeAnimation, PercentageBehavior.PercentageBehavior, and TurnTableBehavior.TurnTableBehavior.
| Behavior.Behavior.parameterCount | ( | ) |
| Behavior.Behavior.isRuntimeParameter | ( | ) |
Return true if the specified parameter is a "runtime-only" parameter.
These parameters are not saved to the scene file. See addParameter().
| Behavior.Behavior.setRuntimeParameter | ( | ) |
Sets whether or not a parameter is "runtime-only" or not.
| Behavior.Behavior.initParameters | ( | ) |
Virtual method, called after a behavior is read from a scene file.
Subclasses can override this method to complete their initialization. For instance, runtime-only parameters might be initialized.
Reimplemented in FbxBehavior.FbxBehavior, KeyframeAnimation.KeyframeAnimation, PercentageBehavior.PercentageBehavior, and TurnTableBehavior.TurnTableBehavior.
| Behavior.Behavior.reset | ( | ) |
| Behavior.Behavior.getNodes | ( | ) |
Returns a set of node ids that this behavior is assigned to.
| Behavior.Behavior.validateNodesSelection | ( | ) |
Make it possible for a behavior to control which selection it accepts, override and return false for unacceptable selections.
Reimplemented in KeyframeAnimation.KeyframeAnimation.
| Behavior.Behavior.setNodeDeletionCallback | ( | ) |
| Behavior.Behavior.setPlaybackStatusChangedCallback | ( | ) |
| Behavior.Behavior.onNodeDeleted | ( | ) |
Removes the deleted node from this behavior.
Reimplemented in KeyframeAnimation.KeyframeAnimation.
| Behavior.Behavior.addNodes | ( | ) |
Add nodes to this behaviour.
Returns true if any new nodes have been added to the behavior.
Reimplemented in FbxBehavior.FbxBehavior, KeyframeAnimation.KeyframeAnimation, MasterBehavior.MasterBehavior, PercentageBehavior.PercentageBehavior, TriggerBehavior.TriggerBehavior, and TurnTableBehavior.TurnTableBehavior.
| Behavior.Behavior.getRemoveNodesUndoMessages | ( | ) |
Implement to allow behaviors to have custom data that needs to be readded at undo of remove.
Reimplemented in KeyframeAnimation.KeyframeAnimation.
| Behavior.Behavior.removeNodes | ( | ) |
Remove the nodes from this behaviour.
Returns true if any nodes have been removed from the behavior.
Reimplemented in FbxBehavior.FbxBehavior, KeyframeAnimation.KeyframeAnimation, MasterBehavior.MasterBehavior, PercentageBehavior.PercentageBehavior, TriggerBehavior.TriggerBehavior, and TurnTableBehavior.TurnTableBehavior.
| Behavior.Behavior.dirtyNodes | ( | ) |
Call this method when the nodes of this behaviour have been updated outside of this behaviour.
Reimplemented in TurnTableBehavior.TurnTableBehavior.
| Behavior.Behavior.otherBehaviorRemoved | ( | ) |
Since some behaviors can reference behaviors they need to override this to clean up on remove.
Reimplemented in MasterBehavior.MasterBehavior.
| Behavior.Behavior.toggleActive | ( | ) |
| Behavior.Behavior.activate | ( | ) |
| Behavior.Behavior.deactivate | ( | ) |
| Behavior.Behavior.setIsActive | ( | ) |
Reimplemented in TurnTable.TurnTable, and TurnTableBehavior.TurnTableBehavior.
| Behavior.Behavior.isActive | ( | ) |
| Behavior.Behavior.setIsEnabled | ( | ) |
| Behavior.Behavior.isEnabled | ( | ) |
| Behavior.Behavior.getDuration | ( | ) |
Reimplemented in FbxBehavior.FbxBehavior, and TurnTableBehavior.TurnTableBehavior.
| Behavior.Behavior.getDurationForExecutableAction | ( | ) |
| Behavior.Behavior.play | ( | ) |
Reimplemented in TriggerBehavior.TriggerBehavior.
| Behavior.Behavior.playBackward | ( | ) |
| Behavior.Behavior.step | ( | ) |
| Behavior.Behavior.update | ( | ) |
Implement this method in subclasses to perform the actual behavior.
timestep is in seconds.
Reimplemented in FbxBehavior.FbxBehavior, KeyframeAnimation.KeyframeAnimation, PercentageBehavior.PercentageBehavior, ShowHide.ShowHide, TransformBehavior.TransformBehavior, TurnTableBehavior.TurnTableBehavior, and VisibilitySwitch.VisibilitySwitch.
| Behavior.Behavior.ExecutableActions | ( | ) |
| Behavior.Behavior.ObjectExecutableActions | ( | ) |
| Behavior.Behavior.GetExecutableActionLabel | ( | ) |
Return the label corresponding to the specified action, if one has been defined, and the action otherwise.
| Behavior.Behavior.SpeedStandard | ( | ) |
| Behavior.Behavior.SpeedDouble | ( | ) |
| Behavior.Behavior.SpeedHalf | ( | ) |
| Behavior.Behavior.SpeedTen | ( | ) |
| Behavior.Behavior.SpeedTenth | ( | ) |
| Behavior.Behavior.PlayFromStart | ( | ) |
| Behavior.Behavior.PlayFromEnd | ( | ) |
| Behavior.Behavior.Pause | ( | ) |
| Behavior.Behavior.Continue | ( | ) |
| Behavior.Behavior.StopAndResetToStart | ( | ) |
| Behavior.Behavior.StopAndResetToEnd | ( | ) |
| Behavior.Behavior.ContinueForward | ( | ) |
| Behavior.Behavior.ContinueBackward | ( | ) |
| Behavior.Behavior.preRead | ( | ) |
| Behavior.Behavior.read | ( | ) |
Reimplemented in MasterBehavior.MasterBehavior.
| Behavior.Behavior.postRead | ( | ) |
Reimplemented in KeyframeAnimation.KeyframeAnimation, and MasterBehavior.MasterBehavior.
| Behavior.Behavior.preWrite | ( | ) |
Reimplemented in FbxBehavior.FbxBehavior, and KeyframeAnimation.KeyframeAnimation.
| Behavior.Behavior.Write | ( | ) |
Reimplemented in MasterBehavior.MasterBehavior.
| Behavior.Behavior.postWrite | ( | ) |
| Behavior.Behavior.basename | ( | ) |
Return a basename that will be used to build names and labels.
Derived classes will typically override this method.
Reimplemented from Loadable.Loadable.
Reimplemented in FbxBehavior.FbxBehavior, KeyframeAnimation.KeyframeAnimation, MasterBehavior.MasterBehavior, PercentageBehavior.PercentageBehavior, TransformBehavior.TransformBehavior, TriggerBehavior.TriggerBehavior, and TurnTableBehavior.TurnTableBehavior.
Member Data Documentation
| string Behavior.Behavior.kLabel = "Label" |
| string Behavior.Behavior.kNodes = "Nodes" |
| string Behavior.Behavior.kNodesList = "NodesList" |
| string Behavior.Behavior.kThumbnail = "Thumbnail" |
| string Behavior.Behavior.kDirection = "Direction" |
| string Behavior.Behavior.kStartDirection = "StartDirection" |
| string Behavior.Behavior.kActivatedType = "ActivatedType" |
| string Behavior.Behavior.kActivatedId = "ActivatedId" |
| string Behavior.Behavior.kActivatedCommand = "ActivatedCommand" |
| string Behavior.Behavior.kFloatTuple = "Floats" |
| string Behavior.Behavior.kStringTuple = "Strings" |
| string Behavior.Behavior.kStringSet = "StringSet" |
| string Behavior.Behavior.kAffineMatrix = "AffineMatrix" |
| string Behavior.Behavior.kFile = "Filename" |
Reimplemented in TriggerBehavior.TriggerBehavior.
Reimplemented in FbxBehavior.FbxBehavior.
