Pyrogenesis trunk
Public Types | Public Member Functions | List of all members
IObstructionTestFilter Class Referenceabstract

Interface for ICmpObstructionManager Test functions to filter out unwanted shapes. More...

#include <ICmpObstructionManager.h>

Inheritance diagram for IObstructionTestFilter:
Inheritance graph
[legend]

Public Types

typedef ICmpObstructionManager::tag_t tag_t
 
typedef ICmpObstructionManager::flags_t flags_t
 

Public Member Functions

virtual ~IObstructionTestFilter ()
 
virtual bool TestShape (tag_t tag, flags_t flags, entity_id_t group, entity_id_t group2) const =0
 Return true if the shape with the specified parameters should be tested for collisions. More...
 

Detailed Description

Interface for ICmpObstructionManager Test functions to filter out unwanted shapes.

Member Typedef Documentation

◆ flags_t

◆ tag_t

Constructor & Destructor Documentation

◆ ~IObstructionTestFilter()

virtual IObstructionTestFilter::~IObstructionTestFilter ( )
inlinevirtual

Member Function Documentation

◆ TestShape()

virtual bool IObstructionTestFilter::TestShape ( tag_t  tag,
flags_t  flags,
entity_id_t  group,
entity_id_t  group2 
) const
pure virtual

Return true if the shape with the specified parameters should be tested for collisions.

This is called for all shapes that would collide, and also for some that wouldn't.

Parameters
tagtag of shape being tested
flagsset of EFlags for the shape
groupthe control group of the shape (typically the shape's unit, or the unit's formation controller, or 0)
group2an optional secondary control group of the shape, or INVALID_ENTITY if none specified. Currently exists only for static shapes.

Implemented in NullObstructionFilter, StationaryOnlyObstructionFilter, ControlGroupMovementObstructionFilter, SkipControlGroupsRequireFlagObstructionFilter, SkipTagRequireControlGroupsAndFlagObstructionFilter, SkipTagObstructionFilter, SkipTagAndControlGroupObstructionFilter, and SkipTagRequireFlagsObstructionFilter.


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