SkipTagAndControlGroupObstructionFilter Class Reference

Similar to ControlGroupMovementObstructionFilter, but also ignoring a specific tag. More...

#include <ICmpObstructionManager.h>

Inheritance diagram for SkipTagAndControlGroupObstructionFilter:

Collaboration diagram for SkipTagAndControlGroupObstructionFilter:

Public Member Functions
	SkipTagAndControlGroupObstructionFilter (tag_t tag, bool avoidMoving, entity_id_t group)
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
entity_id_t	m_Group
tag_t	m_Tag
bool	m_AvoidMoving

Additional Inherited Members
Public Types inherited from IObstructionTestFilter
typedef ICmpObstructionManager::tag_t	tag_t
typedef ICmpObstructionManager::flags_t	flags_t

Detailed Description

Similar to ControlGroupMovementObstructionFilter, but also ignoring a specific tag.

See D3482 for why this exists.

Constructor & Destructor Documentation

SkipTagAndControlGroupObstructionFilter()

SkipTagAndControlGroupObstructionFilter::SkipTagAndControlGroupObstructionFilter ( tag_t  tag, bool  avoidMoving, entity_id_t  group  )

inline

Member Function Documentation

TestShape()

virtual bool SkipTagAndControlGroupObstructionFilter::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

tag	tag of shape being tested
flags	set of EFlags for the shape
group	the control group of the shape (typically the shape's unit, or the unit's formation controller, or 0)
group2	an 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_AvoidMoving

bool SkipTagAndControlGroupObstructionFilter::m_AvoidMoving

private

m_Group

entity_id_t SkipTagAndControlGroupObstructionFilter::m_Group

private

m_Tag

tag_t SkipTagAndControlGroupObstructionFilter::m_Tag

private

---

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

• /home/docker/jenkins/workspace/technical-docs/source/simulation2/components/ICmpObstructionManager.h