Description

! Interface class used by APIRayFireReadOnly and APIIntersectsNegativeSideOfPlanesReadOnly.

It defines ! two methods that allow calls to these two APIs to be optmized. If the Ignore method returns true ! the object will nto be added to the hit results. If the Abort method returns true, the execution of the APIs ! is stopped. This may be useful during interactive operations, such as inferencing.

#include <WSM_Constants.h>

Inheritance diagram for WSM::IRayFireFilterAndAbort:

Public Member Functions
virtual bool	Ignore (const WSM::GroupInstancePath &, double)
	! Ignore interface. More...

virtual bool	Abort (size_t)
	! Abort interface. More...

Member Function Documentation

virtual bool WSM::IRayFireFilterAndAbort::Abort ( size_t )

inlinevirtual

! Abort interface.

If this method returns true, the execution of the API is stopped and a partial ! hit result will be returned. The currentNumberOfHits arguments indicates how many hits have been ! found so far. It can be used to abort when too many hits are being accumulated to be useful.

virtual bool WSM::IRayFireFilterAndAbort::Ignore	(	const WSM::GroupInstancePath &	,
		double
	)

inlinevirtual

! Ignore interface.

The path argument defines the object to be tested. If the ! depth parameter is less than WSM_DISTANCE_BIG, the Ignore is intended to check whether ! the object should be ignore based on its depth. One use is to check whether the object is hidden by a ! section plane.

Reimplemented in WSM::Utils::RayFireFilterHiddenOrNonPickable, WSM::Utils::RayFireFilterHiddenOrSectioned, and WSM::Utils::RayFireFilterHidden.

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

WSM/WSM_Constants.h

Description

Public Member Functions

Member Function Documentation