VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
subSurfaceDepthController.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2013 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
9 
10 #pragma once
11 
13 
16 class DtAnalogOutputPort;
18 
19 enum
20 {
26 };
27 
34 {
35 
36 public:
37 
44  DtVrfObject* owner,
45  DtSimManager* simManager,
46  DtComponentDescriptor* desc = 0,
47  DtReaderWriterRegistry* parentRegistry = 0);
48 
52  virtual ~DtSubSurfaceDepthController();
53 
56  virtual const char* type() const;
57 
60  virtual bool init();
61 
62  static void gotoDepthCallback(DtSimMessage* msg, void* usr);
63 
64  virtual void processGotoDepthTask(DtSimMessage* msg);
65 
66  virtual void registerTaskMsgCallbacks();
67 
70  virtual void tick();
71 
74  virtual double entityDepth();
75 
78 
82  static DtSimComponent * creator(const DtString& name,
83  DtVrfObject* owner,
84  DtSimManager* simManager,
85  DtComponentDescriptor* desc = 0,
86  DtReaderWriterRegistry* parentRegistry = 0);
87 
88 
89 protected:
90 
92  virtual bool createPorts();
93 
95  virtual void clearTask();
96 
104  virtual void lookupAndCacheProcessSR();
105 
109  virtual bool postAddComponentsInit();
110 
111 private:
112 
115 
118  const DtSubSurfaceDepthController & orig);
119 
122  const DtSubSurfaceDepthController & orig);
123 
124 
125 protected:
126 
128 
131 
134 
137 
144 
145 
155 
164 };
#define DT_DLL_vrfmodel
This file is used to determine how to build.
Definition: vrfmodelDefines.h:24
virtual bool postAddComponentsInit()
Called after all components have been created, initialized and added to the component manager...
Definition: simComponent.h:144
Definition: subSurfaceDepthController.h:25
DtVrfObject is used to represent any type of simulated object (entities, aggregate, control objects) in a VR-Forces application.
Definition: vrfObject.h:215
Description: This repository holds all information that is common to all the forms of all objects wit...
Definition: vrfMovingObjectStateRepository.h:26
Definition: surfaceMovementPSR.h:58
virtual void registerTaskMsgCallbacks()
DtSubsurfaceEntityParameters.
Definition: subSurfaceEntityParameters.h:20
This class provides a base class for all controllers that are capable of executing a DtSimTask...
Definition: singleTaskControllerComponent.h:20
A readable, writable type whose name is the name of a component and that has a list of component name...
Definition: componentDescriptor.h:42
Definition: readerWriterRegistry.h:39
virtual const char * type() const =0
Returns a string identifies the class type of component.
virtual bool init()
Calls setRadio()
Definition: subSurfaceDepthController.h:21
DtVrfMovingObjectStateRepository * myEntityState
Definition: subSurfaceDepthController.h:127
virtual void clearTask()
If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false...
const DtSubSurfaceEntityParameters * myParameters
Cache a pointer to the entity parameters.
Definition: subSurfaceDepthController.h:136
Instances of DtAnalogOutputPort are input ports through which data producers can send real numbers...
Definition: analogIOPort.h:45
DtAnalogOutputPort * myClampDepthPort
Output Port Name: clamp-depth Output Port Description: The goal speed; used by the actuator to preven...
Definition: subSurfaceDepthController.h:162
File: simMsg.h.
Definition: simMessage.h:35
virtual void tick()
This gives the thread of control to the component.
virtual bool createPorts()
Called by init.
The DtSimComponent class is the base class for the entire simulation model component hierarchy...
Definition: simComponent.h:67
Definition: subSurfaceDepthController.h:23
const DtTaskControllerComponent & operator=(const DtTaskControllerComponent &orig)
assignment operator
Definition: subSurfaceDepthController.h:22
The simulation engine is controlled by a single,top-level class called the Simulation Manager...
Definition: simManager.h:102
DtSurfaceMovementPSR * myProcessState
No special parameters for this controller.
Definition: subSurfaceDepthController.h:133
The DtSubSurfaceDepthController controls the depth for subsurface entities.
Definition: subSurfaceDepthController.h:32
DtAnalogOutputPort * myDepthRatePort
Definition: subSurfaceDepthController.h:154
Definition: subSurfaceDepthController.h:24

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)