prj/cam/src/actreact/stimsens.h

   1 /*
   2 @Copyright Looking Glass Studios, Inc.
   3 1996,1997,1998,1999,2000 Unpublished Work.
   4 */
   5
   6 // $Header: r:/t2repos/thief2/src/actreact/stimsens.h,v 1.6 2000/01/29 12:44:48 adurant Exp $
   7 #pragma once
   8
   9 #ifndef __STIMSENS_H
  10 #define __STIMSENS_H
  11
  12 #include <comtools.h>
  13 #include <stimtype.h>
  14 #include <senstype.h>
  15 #include <objtype.h>
  16 #include <osystype.h>
  17
  18 ////////////////////////////////////////////////////////////
  19 // STIMULUS SENSORS COM INTERFACE
  20 //
  21
  22 #undef INTERFACE
  23 #define INTERFACE IStimSensors
  24
  25 DECLARE_INTERFACE_(IStimSensors,IUnknown)
  26 {
  27    DECLARE_UNKNOWN_PURE();
  28
  29    //
  30    // Add a receptron to an object (copies the data)
  31    // If the object does not have a "sensor" for the receptron's stimulus, creates
  32    // one.
  33    //
  34    STDMETHOD_(ReceptronID,AddReceptron)(THIS_ ObjID obj, StimID stimulus, const sReceptron* tron) PURE;
  35    // Remove a receptron, removes the sensor if it was the last one for that
  36    // stimulus
  37    STDMETHOD(RemoveReceptron)(THIS_ ReceptronID) PURE;
  38
  39    //
  40    // Look up a receptron's obj/stim pair by ID
  41    //
  42    STDMETHOD_(sObjStimPair, GetReceptronElems)(THIS_ ReceptronID id) PURE;
  43    //
  44    // Get a receptron's data structure
  45    //
  46    STDMETHOD(GetReceptron)(THIS_ ReceptronID id, sReceptron* tron) PURE;
  47    //
  48    // Mutate a receptron
  49    //
  50    STDMETHOD(SetReceptron)(THIS_ ReceptronID id, const sReceptron* tron) PURE;
  51
  52    //
  53    // Query the receptron database.  does not account for inheritance on the
  54    // part of obj.
  55    //
  56    STDMETHOD_(IReceptronQuery*,QueryReceptrons)(THIS_ ObjID obj, StimID stim) PURE;
  57
  58    //
  59    // Query receptrons, including those inherited by obj
  60    //
  61    STDMETHOD_(IReceptronQuery*,QueryInheritedReceptrons)(THIS_ ObjID obj, StimID stim) PURE;
  62
  63    //
  64    // Return the objects that have special meaning when used as receptron
  65    // object parameters.
  66    //
  67    STDMETHOD_(ObjID,ObjParam)(THIS_ eReactObjParam which) PURE;
  68
  69    //
  70    // Query sensors, OBJ_NULL is a wildcard.
  71    //
  72    STDMETHOD_(IStimSensorQuery*,QuerySensors)(THIS_ ObjID obj, StimID stim) PURE;
  73
  74    //
  75    // Look up the ID of a sensor on an object for a stimulus
  76    //
  77    STDMETHOD_(StimSensorID, LookupSensor)(THIS_ ObjID obj, StimID stim) PURE;
  78
  79    //
  80    // Get the the object and stimulus associated with a sensor
  81    //
  82    STDMETHOD_(sObjStimPair,GetSensorElems)(THIS_ StimSensorID ID) PURE;
  83
  84    //
  85    // Notify the stimsensors about database changes
  86    //
  87    STDMETHOD(DatabaseNotify)(THIS_ tStimDatabaseMsg msg, IUnknown* file) PURE;
  88
  89    //
  90    // Notify about object creation/deletion
  91    //
  92    STDMETHOD(ObjectNotify)(THIS_ eObjNotifyMsg msg, ObjNotifyData data) PURE;
  93
  94
  95 };
  96
  97 //------------------------------------------------------------
  98 // Aggregate member factory
  99 //
 100
 101 EXTERN void StimSensorsCreate(void);
 102
 103
 104 //------------------------------------------------------------
 105 // Receptron query API
 106 //
 107
 108 #undef INTERFACE
 109 #define INTERFACE IReceptronQuery
 110
 111 DECLARE_INTERFACE_(IReceptronQuery,IUnknown)
 112 {
 113    DECLARE_UNKNOWN_PURE();
 114
 115    //
 116    // Iteration
 117    //
 118    STDMETHOD(Start)(THIS) PURE;
 119    STDMETHOD_(BOOL,Done)(THIS) PURE;
 120    STDMETHOD(Next)(THIS) PURE;
 121
 122    //
 123    // Accessors
 124    //
 125    STDMETHOD_(sObjStimPair,Elems)(THIS) PURE;
 126    STDMETHOD_(ReceptronID,ID)(THIS) PURE;
 127    // Ptr is only valid until Next() or final Release()
 128    STDMETHOD_(const sReceptron*, Receptron)(THIS) PURE;
 129
 130 };
 131
 132
 133 //------------------------------------------------------------
 134 // Sensor Query API
 135 //
 136
 137 #undef INTERFACE
 138 #define INTERFACE IStimSensorQuery
 139
 140 DECLARE_INTERFACE_(IStimSensorQuery,IUnknown)
 141 {
 142    DECLARE_UNKNOWN_PURE();
 143
 144    //
 145    // Iteration
 146    //
 147    STDMETHOD(Start)(THIS) PURE;
 148    STDMETHOD_(BOOL,Done)(THIS) PURE;
 149    STDMETHOD(Next)(THIS) PURE;
 150
 151    //
 152    // Accessors
 153    //
 154    STDMETHOD_(sObjStimPair,Elems)(THIS) PURE;
 155    STDMETHOD_(StimSensorID,ID)(THIS) PURE;
 156
 157 };
 158
 159
 160 #endif // __STIMSENS_H
 161
 162
 163
 164
 165