Obstruction test filter that reject shapes in a given control group, and rejects shapes that don't block unit movement, and optionally rejects moving shapes. More...

#include <ICmpObstructionManager.h>

Inheritance diagram for ControlGroupMovementObstructionFilter:

[legend]

Collaboration diagram for ControlGroupMovementObstructionFilter:

[legend]

Public Member Functions
	ControlGroupMovementObstructionFilter (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
bool	m_AvoidMoving

entity_id_t	m_Group

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 reject shapes in a given control group, and rejects shapes that don't block unit movement, and optionally rejects moving shapes.

Constructor & Destructor Documentation

◆ ControlGroupMovementObstructionFilter()

ControlGroupMovementObstructionFilter::ControlGroupMovementObstructionFilter	(	bool	avoidMoving,
		entity_id_t	group
	)

inline

Member Function Documentation

◆ TestShape()

virtual bool ControlGroupMovementObstructionFilter::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 ControlGroupMovementObstructionFilter::m_AvoidMoving

private

◆ m_Group

entity_id_t ControlGroupMovementObstructionFilter::m_Group

private

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

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

Public Member Functions

Private Attributes

Additional Inherited Members