Actin  Version 5.5.5
Software for Robotics Simulation and Control
ecMoveDirectionVisitor.h
Go to the documentation of this file.
1 #ifndef ecMoveDirectionVisitor_H_
2 #define ecMoveDirectionVisitor_H_
3 //------------------------------------------------------------------------------
4 // Copyright (c) 2002-2013 Energid Technologies. All rights reserved.
5 //
9 //
10 //------------------------------------------------------------------------------
11 #include <actin/actin_config.h> // Required to be first header.
12 #include <foundCore/ecMacros.h>
13 
15 
18 {
19 public:
22  (
23  EcU32 sceneIndex,
24  const EcString& role,
25  EcU32 oldDirectionIndex,
26  EcU32 newDirectionIndex
27  );
28 
30  virtual ~EcMoveDirectionVisitor
31  (
32  ) {}
33 
35  virtual EcBoolean success
36  (
37  ) const EC_OVERRIDE;
38 
40  virtual void visit
41  (
42  EcManipulationDirector& director,
43  EcManipulationDirectorState* pState = 0
44  ) EC_OVERRIDE;
45 
47  virtual void visit
48  (
49  EcManipulationScript& script,
51  EcManipulationScriptState* pState = 0
52  ) EC_OVERRIDE;
53 
54  virtual void visit
55  (
57  EcManipulationSceneState* pState = 0
58  ) EC_OVERRIDE;
59 
61  virtual void visit
62  (
63  EcManipulationScene& scene,
64  EcManipulationSceneState* pState = 0
65  ) EC_OVERRIDE;
66 
67 protected:
70 
73 
76 
79 
82 };
83 
84 #endif // ecMoveDirectionVisitor_H_
EcU32 m_SceneIndex
index of the scene where the direction will be moved
EcU32 m_NewDirectionIndex
destination index where the direction should move
Organizes manipulation scene directions for multiple manipulator roles.
Organizes multiple manipulation scenes.
EcBoolean m_Success
flag indicating if the move was successful
ecboost::uint32_t EcU32
32-bit unsigned integer
Definition: ecTypes.h:53
#define EC_OVERRIDE
Add wrapper around c++11 override keyword.
Definition: ecMacros.h:40
Concrete implementation of EcDirectorObject that holds an EcManipulationScene object.
virtual void visit(EcManipulationDirector &director, EcManipulationDirectorState *pState=0)=0
visit a manipulation director
Holds EcManipulationScene state information.
EcU32 m_OldDirectionIndex
current index of the direction to move
Organizes multiple manipulation director objects into a directory hierarchy.
#define EC_ACTIN_MANIPULATIONDIRECTOR_DECL
manipulationDirector directory
Definition: actin_config.h:212
Virtual base class for defining visitor algorithms for manipulationDirector objects.
virtual EcBoolean success() const =0
returns a flag indicating of the visitor was successful
Visitor implementation for moving a direction.
bool EcBoolean
Boolean (0 or 1)
Definition: ecTypes.h:21
std::basic_string< char > EcString
a character string
Definition: ecTypes.h:116
Macros and C-style general functions.
Holds EcManipulationDirector state information.
Directs a cast to run a manipulation script.
EcString m_Role
role name where the direction will be moved
Holds EcManipulationScript state information.
Configuration header for the actin hierarchy.