Interface of a capsule factory responsible for creating and destroying capsule instances in a capsule part. More...
#include <RTActorFactoryInterface.h>
Inheritance diagram for RTActorFactoryInterface:
Public Member Functions | |
| virtual RTActor * | create (RTController *rts, RTActorRef *ref, int index)=0 |
| Called by the TargetRTS to create a capsule instance, which later will be inserted into a capsule part. | |
| virtual void | destroy (RTActor *actor)=0 |
| Called by the TargetRTS to destroy a capsule instance. | |
Detailed Description
Interface of a capsule factory responsible for creating and destroying capsule instances in a capsule part.
Member Function Documentation
◆ create()
|
pure virtual |
Called by the TargetRTS to create a capsule instance, which later will be inserted into a capsule part.
- Parameters
-
[in] rts The controller that would run the new capsule instance by default [in] ref The capsule part where the created instance will later be inserted [in] index The index within the capsule part where the instance will later be inserted
- Returns
- The created capsule instance, ready to be inserted into the capsule part. If nullptr is returned the TargetRTS will use the capsule's RTActorCreator for creating the instance.
Implemented in RTActorFactory, RTDefaultActorFactory< CapsuleClass >, and RTDefaultActorFactory_NoCreate.
◆ destroy()
|
pure virtual |
Called by the TargetRTS to destroy a capsule instance.
- Parameters
-
[in] actor Capsule instance to be destroyed
Implemented in RTActorFactory, RTDefaultActorFactory< CapsuleClass >, and RTDefaultActorFactory_NoCreate.
The documentation for this class was generated from the following file:
