libHSPlasma
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
plDetectorModifier Class Reference

#include <plDetectorModifier.h>

Inheritance diagram for plDetectorModifier:
plSingleModifier plModifier plSynchedObject hsKeyedObject plCreatable plCollisionDetector plPickingDetector plObjectInVolumeDetector plPanicLinkRegion plSubworldRegionDetector plCameraRegionDetector plObjectInVolumeAndFacingDetector

Public Member Functions

virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
const std::vector< plKey > & getReceivers () const
std::vector< plKey > & getReceivers ()
void addReceiver (plKey rcvr)
void delReceiver (size_t idx)
void clearReceivers ()
plKey getRemoteMod () const
plKey getProxy () const
void setRemoteMod (plKey mod)
void setProxy (plKey proxy)
- Public Member Functions inherited from plSingleModifier
bool getFlag (size_t flag) const
void setFlag (size_t flag, bool value)
virtual size_t getTargetsCount () const
virtual plKey getTarget (size_t) const
virtual void addTarget (plKey target)
virtual void removeTarget (plKey)

Protected Member Functions

virtual void IPrcWrite (pfPrcHelper *prc)
virtual void IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Attributes

std::vector< plKeyfReceivers
plKey fRemoteMod
plKey fProxyKey
- Protected Attributes inherited from plSingleModifier
hsBitVector fFlags
plKey fTarget

Additional Inherited Members

- Public Types inherited from plSynchedObject
enum  Flags {
  kDontDirty = 0x1, kSendReliably = 0x2, kHasConstantNetGroup = 0x4, kDontSynchGameMessages = 0x8,
  kExcludePersistentState = 0x10, kExcludeAllPersistentState = 0x20, kLocalOnly = kExcludeAllPersistentState | kDontSynchGameMessages, kHasVolatileState = 0x40,
  kAllStateIsVolatile = 0x80
}
enum  SDLSendFlags {
  kBCastToClients = 0x1, kForceFullSend = 0x2, kSkipLocalOwnershipCheck = 0x4, kSendImmediately = 0x8,
  kDontPersistOnServer = 0x10, kUseRelevanceRegions = 0x20, kNewState = 0x40, kIsAvatarState = 0x80
}

Member Function Documentation

void plDetectorModifier::addReceiver ( plKey  rcvr)
void plDetectorModifier::clearReceivers ( )
void plDetectorModifier::delReceiver ( size_t  idx)
plKey plDetectorModifier::getProxy ( ) const
const std::vector<plKey>& plDetectorModifier::getReceivers ( ) const
std::vector<plKey>& plDetectorModifier::getReceivers ( )
plKey plDetectorModifier::getRemoteMod ( ) const
virtual void plDetectorModifier::IPrcParse ( const pfPrcTag tag,
plResManager mgr 
)
protectedvirtual

This must be overloaded by subclasses to parse PRC data specific to the class from the PRC document. It is called once for each tag that is a child to the Creatable tag itself, so subclasses should check for each supported tag and handle it accordingly if it matches. If the tag is not recognized, it should be passed along to the parent class.

Reimplemented from plSingleModifier.

Reimplemented in plPanicLinkRegion, plSubworldRegionDetector, plObjectInVolumeAndFacingDetector, plCollisionDetector, and plCameraRegionDetector.

virtual void plDetectorModifier::IPrcWrite ( pfPrcHelper prc)
protectedvirtual

This must be overloaded by subclasses to write PRC data specific to the class to the PRC document. Do not write the top-level creatable tag, that is handled by prcWrite().

Reimplemented from plSingleModifier.

Reimplemented in plPanicLinkRegion, plSubworldRegionDetector, plObjectInVolumeAndFacingDetector, plCollisionDetector, and plCameraRegionDetector.

virtual void plDetectorModifier::read ( hsStream ,
plResManager  
)
virtual

Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.

Reimplemented from plSingleModifier.

Reimplemented in plPanicLinkRegion, plSubworldRegionDetector, plObjectInVolumeAndFacingDetector, plCollisionDetector, and plCameraRegionDetector.

void plDetectorModifier::setProxy ( plKey  proxy)
void plDetectorModifier::setRemoteMod ( plKey  mod)
virtual void plDetectorModifier::write ( hsStream ,
plResManager  
)
virtual

Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.

Reimplemented from plSingleModifier.

Reimplemented in plPanicLinkRegion, plSubworldRegionDetector, plObjectInVolumeAndFacingDetector, plCollisionDetector, and plCameraRegionDetector.

Member Data Documentation

plKey plDetectorModifier::fProxyKey
protected
std::vector<plKey> plDetectorModifier::fReceivers
protected
plKey plDetectorModifier::fRemoteMod
protected

The documentation for this class was generated from the following file: