Pyrogenesis HEAD
Pyrogenesis, a RTS Engine
Public Member Functions | Private Attributes | List of all members
SkipTagRequireFlagsObstructionFilter Class Reference

Obstruction test filter that will test only against shapes that: More...

#include <ICmpObstructionManager.h>

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

Public Member Functions

 SkipTagRequireFlagsObstructionFilter (tag_t tag, flags_t mask)
 
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 ()
 
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...
 

Private Attributes

tag_t m_Tag
 
flags_t m_Mask
 

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
  • AND have at least one of the specified flags set.

Constructor & Destructor Documentation

◆ SkipTagRequireFlagsObstructionFilter()

SkipTagRequireFlagsObstructionFilter::SkipTagRequireFlagsObstructionFilter ( tag_t  tag,
flags_t  mask 
)
inline

Member Function Documentation

◆ TestShape()

virtual bool SkipTagRequireFlagsObstructionFilter::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_Mask

flags_t SkipTagRequireFlagsObstructionFilter::m_Mask
private

◆ m_Tag

tag_t SkipTagRequireFlagsObstructionFilter::m_Tag
private
The documentation for this class was generated from the following file: