AddToGroupOperation Class Reference

A operation to add a object to a existing group. More...

#include <MemoryX/gui-plugins/SceneEditor/controller/AddToGroupOperation.h>

+ Inheritance diagram for AddToGroupOperation:

Public Member Functions

 AddToGroupOperation (const std::shared_ptr< memoryxcontroller::MemoryXController > &memoryXController, const std::shared_ptr< scene3D::Scene > &scene, const std::string &groupName, const std::string &objectId)
 Creates a new operation, which adds a new object to a group. More...
 
const OperationPtr createInverseOperation () const override
 Returns a new operation which removes the object from the group. More...
 
- Public Member Functions inherited from Operation
std::string getObjectId () const
 Returns the ID of the object, this Operation is working on. More...
 
virtual bool isExecuteable ()
 Return wehether the operation can be executed currently. More...
 
 Operation (const std::shared_ptr< memoryxcontroller::MemoryXController > &memoryXController, const std::shared_ptr< scene3D::Scene > &scene)
 A constructor. More...
 
 Operation (const std::shared_ptr< memoryxcontroller::MemoryXController > &memoryXController, const std::shared_ptr< scene3D::Scene > &scene, const std::string &objectId)
 A constructor. More...
 

Protected Member Functions

void executeOnScene () override
 Adds the object to the group. More...
 
void executeOnWorkingMemory () override
 Because the WorkingMemory does not support groups, nothing is done here. More...
 
- Protected Member Functions inherited from Operation
const std::shared_ptr< memoryxcontroller::MemoryXControllergetMemoryXController () const
 Returns the the MemoryXController to execute the Operation at. More...
 
const std::shared_ptr< scene3D::ScenegetScene () const
 Returns the the Scene to execute the Operation at. More...
 
void setObjectId (const std::string &objectId)
 Sets the ID, this operation is working on. More...
 

Detailed Description

A operation to add a object to a existing group.

See also
controller::Operation

Definition at line 41 of file AddToGroupOperation.h.

Constructor & Destructor Documentation

◆ AddToGroupOperation()

AddToGroupOperation ( const std::shared_ptr< memoryxcontroller::MemoryXController > &  memoryXController,
const std::shared_ptr< scene3D::Scene > &  scene,
const std::string &  groupName,
const std::string &  objectId 
)

Creates a new operation, which adds a new object to a group.

Parameters
memoryXControllerThe MemoryXController to execute the operation on. (This is currently not used.)
sceneThe scene to execute the operation on.
groupNameThe group to add the object to.
objectIdThe object ID of the object to add.
See also
controller::Operation::Operation

Definition at line 33 of file AddToGroupOperation.cpp.

Member Function Documentation

◆ createInverseOperation()

const controller::OperationPtr createInverseOperation ( ) const
overridevirtual

Returns a new operation which removes the object from the group.

Returns
The operation, which removes the object from the group.
See also
controller::Operation::createInverseOperation

Implements Operation.

Definition at line 40 of file AddToGroupOperation.cpp.

◆ executeOnScene()

void executeOnScene ( )
overrideprotectedvirtual

Adds the object to the group.

See also
controller::Operation::executeOnScene

Implements Operation.

Definition at line 59 of file AddToGroupOperation.cpp.

◆ executeOnWorkingMemory()

void executeOnWorkingMemory ( )
overrideprotectedvirtual

Because the WorkingMemory does not support groups, nothing is done here.

See also
controller::Operation::executeOnWorkingMemory

Implements Operation.

Definition at line 54 of file AddToGroupOperation.cpp.


The documentation for this class was generated from the following files: