Workspace 6.21.5
Public Member Functions | List of all members
SceneInteraction Class Referenceabstract

#include <Rendering/SceneInteraction/sceneinteraction.h>

Inheritance diagram for SceneInteraction:
[legend]

Public Member Functions

virtual ~SceneInteraction ()=default
 
virtual void execute (DataExecution::Workspace &rootWorkspace, SceneInteractionWidget &widget)=0
 Performs the changes to the workspace hierarchy associated with the interaction.
 
virtual bool isSame (const SceneInteraction &otherInteraction) const =0
 
bool operator== (const SceneInteraction &otherInteraction) const
 

Detailed Description

An abstract base class for interactions with the scene generated by the user interacting with the SceneInteractionWidget. These interactions may occur while the workspace is executing so one of these objects is created at the time the interaction occurs. Then at a later time when it's safe to make changes to the workspace hierarchy this interaction can be executed at which point it can perform the desired change.

Constructor & Destructor Documentation

◆ ~SceneInteraction()

virtual ~SceneInteraction ( )
virtualdefault

Member Function Documentation

◆ execute()

virtual void execute ( DataExecution::Workspace rootWorkspace,
SceneInteractionWidget widget 
)
pure virtual
Parameters
rootWorkspaceThe root of the workspace hierarchy.
widgetThe scene interaction widget which this interaction originated from.

Implemented in AddSceneItem, FocusOnSceneItem, RemoveSceneItem, and SceneItemLabelChanged.

◆ isSame()

virtual bool isSame ( const SceneInteraction otherInteraction) const
pure virtual

◆ operator==()

bool operator== ( const SceneInteraction otherInteraction) const
inline