VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
surfaceEntityPatrolBetweenController.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2002 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
11 
12 #pragma once
13 
15 
16 #include <vlutil/vlString.h>
17 
19 class DtSimMessage;
20 
33 
37 {
38 public:
39 
43  DtLocalObject* owner,
44  DtSimulationServices* simManager,
45  DtComponentDescriptor* desc = 0,
46  DtReaderWriterRegistry* parentRegistry = 0);
47 
49  virtual ~DtSurfaceEntityPatrolBetweenController() override;
50 
54  static DtSimComponent * creator(const DtString& name,
55  DtLocalObject* owner,
56  DtSimulationServices* simManager,
57  DtComponentDescriptor* desc = 0,
58  DtReaderWriterRegistry* parentRegistry = 0);
59 
62  virtual const char* type() const override;
63 
72  static void patrolBetweenCallback(DtSimMessage * msg, void * usrData);
73 
86  virtual void processPatrolBetweenTask(DtSimMessage * msg);
87 
89  virtual void tick() override;
90 
94  virtual DtUUID firstWaypoint() const;
95  virtual void setFirstWaypoint(const DtUUID& waypoint);
97 
102  virtual DtUUID secondWaypoint() const;
103  virtual void setSecondWaypoint(const DtUUID& waypoint);
105 
116  virtual bool atGoal() override;
117 
127  virtual bool passedGoal() override;
128 
135  virtual void controlMovement() override;
136 
137 protected:
141  virtual void registerTaskMsgCallbacks() override;
142 
145 
149 
153 };
154 
virtual bool passedGoal()
Determines if the entity has passed the goal. This is true for move-to-loc if the vector from the goa...
UUID is a unique ID wrapper class.
Definition: uuid.h:59
#define DT_DLL_vrfmodel
This file is used to determine how to build.
Definition: vrfmodelDefines.h:24
DtSurfaceEntityMoveToController is a controller that models the movement of a surface entity to a spe...
Definition: surfaceEntityMoveToController.h:29
virtual void registerTaskMsgCallbacks() override
Registers interest in move to tasks by calling addTaskProcessorCallback with moveToCallback as the fu...
virtual void controlMovement()
Executes the control function for the task, to produce control port outputs.
A readable, writable type whose name is the name of a component and that has a list of component name...
Definition: componentDescriptor.h:49
Definition: readerWriterRegistry.h:39
DtSurfaceEntityPatrolBetweenController; patrol between waypoint behavior for a surface entity...
Definition: surfaceEntityPatrolBetweenController.h:35
File: simMsg.h.
Definition: simMessage.h:35
virtual void tick() override
Overridden to check for valid myProcessState pointer. If it is null a warning is printed to the objec...
static DtSimComponent * creator(const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
Central access point of all non-object-specific the services and managers that are available for use ...
Definition: simulationServices.h:96
The DtSimComponent class is the base class for the entire simulation model component hierarchy...
Definition: simComponent.h:89
virtual const char * type() const override
Returns a string identifies the class type of component. Type values are defined in compTypes...
virtual bool atGoal()
Determines when the entity is at the goal. Uses the stoppingDistance parameter.
A locally simulated VRF object.
Definition: localObject.h:98

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)