Pyrogenesis  trunk
Public Member Functions | Private Attributes | List of all members
SkipTagObstructionFilter Class Reference

Obstruction test filter that will test only against shapes that do not have the specified tag set. More...

#include <ICmpObstructionManager.h>

Inheritance diagram for SkipTagObstructionFilter:
Inheritance graph
[legend]
Collaboration diagram for SkipTagObstructionFilter:
Collaboration graph
[legend]

Public Member Functions

 SkipTagObstructionFilter (tag_t tag)
 
virtual bool TestShape (tag_t tag, flags_t flags, entity_id_t group, entity_id_t group2) const
 Return true if the shape with the specified parameters should be tested for collisions. More...
 
- Public Member Functions inherited from IObstructionTestFilter
virtual ~IObstructionTestFilter ()
 

Private Attributes

tag_t m_Tag
 

Additional Inherited Members

- Public Types inherited from IObstructionTestFilter
typedef ICmpObstructionManager::tag_t tag_t
 
typedef ICmpObstructionManager::flags_t flags_t
 

Detailed Description

Obstruction test filter that will test only against shapes that do not have the specified tag set.

Constructor & Destructor Documentation

◆ SkipTagObstructionFilter()

SkipTagObstructionFilter::SkipTagObstructionFilter ( tag_t  tag)
inline

Member Function Documentation

◆ TestShape()

virtual bool SkipTagObstructionFilter::TestShape ( tag_t  tag,
flags_t  flags,
entity_id_t  group,
entity_id_t  group2 
) const
inlinevirtual

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.

Implements IObstructionTestFilter.

Member Data Documentation

◆ m_Tag

tag_t SkipTagObstructionFilter::m_Tag
private

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