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

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

#include <ICmpObstructionManager.h>

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

Public Member Functions

 SkipTagRequireControlGroupsAndFlagObstructionFilter (tag_t tag, entity_id_t group1, entity_id_t group2, flags_t mask)
 
virtual bool TestShape (tag_t tag, flags_t flags, entity_id_t group, entity_id_t group2) const
 
- 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
 
entity_id_t m_Group
 
entity_id_t m_Group2
 
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:

The first (primary) control group to include shapes from must be specified and valid.

This filter is useful for preventing entities with identical control groups from colliding e.g. building a new wall segment on top of an existing wall)

Todo:
This filter needs test cases.

Constructor & Destructor Documentation

SkipTagRequireControlGroupsAndFlagObstructionFilter::SkipTagRequireControlGroupsAndFlagObstructionFilter ( tag_t  tag,
entity_id_t  group1,
entity_id_t  group2,
flags_t  mask 
)
inline

Member Function Documentation

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

Member Data Documentation

entity_id_t SkipTagRequireControlGroupsAndFlagObstructionFilter::m_Group
private
entity_id_t SkipTagRequireControlGroupsAndFlagObstructionFilter::m_Group2
private
flags_t SkipTagRequireControlGroupsAndFlagObstructionFilter::m_Mask
private
tag_t SkipTagRequireControlGroupsAndFlagObstructionFilter::m_Tag
private

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