Detailed Description
- See also:
- Class
CommandMode, Class IScene.
- Description:
- The purpose of this callback is to call INode::FlagForeground() for any nodes in the scene that are supposed to be in the foreground.
#include <objmode.h>
Inheritance diagram for
ChangeFGObject:
Public Member Functions |
|
| ChangeFGObject () | |
| ChangeFGObject (ReferenceTarget *o) | |
| void | SetObj (ReferenceTarget *o) |
| BOOL | IsValid () |
| void | Invalidate () |
| void | Validate () |
| void | callback (TimeValue t, IScene *scene) |
Constructor & Destructor Documentation
| ChangeFGObject | ( | ) | [inline] |
{ obj = NULL; valid = TRUE; }
| ChangeFGObject | ( | ReferenceTarget * | o | ) | [inline] |
{ obj = o; valid = TRUE; }
Member Function Documentation
| void SetObj | ( | ReferenceTarget * | o | ) | [inline] |
{ obj = o; }
| BOOL IsValid | ( | ) | [inline, virtual] |
- Remarks:
- Returns TRUE if this foreground callback is valid ; otherwise FALSE. When the system needs to redraw the viewports the system checks to see if the current foreground callback is the same one that was in place the last time. If it is the same the system will call this method to see if the state is valid. If the state is not valid (this method returns FALSE) then the foreground and background are re-built and then the Validate() method is called so this foreground callback may note that it is invalid.
Implements ChangeForegroundCallback.
{ return valid; }
| void Invalidate | ( | ) | [inline, virtual] |
- Remarks:
- The system calls this method of the plug-in when the foreground state is no longer valid. The plug-in should set a flag internally to indicate it is invalid. For example if the current node selection set changes the system calls this method to mark it as invalid so that the next time the system goes to redraw the viewports it can determine that it would need to rebuild the foreground and the background.
Implements ChangeForegroundCallback.
{ valid = FALSE; }
| void Validate | ( | ) | [inline, virtual] |
- Remarks:
- The system calls this method when the foreground state is valid. For example after the foreground and background buffers have been re-built this method is called. The plug-in should set a flag internally to indicate it is valid.
Implements ChangeForegroundCallback.
{ valid = TRUE; }
| void callback | ( | TimeValue | t, |
| IScene * | scene | ||
| ) | [inline, virtual] |
- Remarks:
- This method is used to enumerate the scene and flag nodes in the scene that need to go in the foreground.
- Parameters:
- TimeValue t
The time to flag the nodes.
IScene *scene
This interface pointer provides methods to enumerate all nodes in the scene, or to flag nodes that are selected, animated or dependent on a given node.
Implements ChangeForegroundCallback.
{
obj->FlagDependents(t);
}
