HitLog Class Reference

This class provides a data structure for keeping a log of hits during sub-object hit-testing. More...

#include <object.h>

Inheritance diagram for HitLog:

Public Member Functions
CoreExport	HitLog ()
	Constructor.
CoreExport	~HitLog ()
	Destructor.
CoreExport void	Clear ()
	Clears the log of hits by deleting the list of HitRecords.
CoreExport void	ClearHitIndex (bool ready=false)
CoreExport void	IncrHitIndex ()
HitRecord *	First ()
	Implemented by the System.
CoreExport HitRecord *	ClosestHit ()
	Implemented by the System.
CoreExport void	LogHit (INode *nr, ModContext *mc, DWORD dist, ulong info, HitData *hitdata=NULL)
	Implemented by the System.

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Detailed Description

This class provides a data structure for keeping a log of hits during sub-object hit-testing.

It provides a list of HitRecords that may be added to and cleared. A developer may also request the 'closest' hit record in the list.

See also

Class HitRecord, Class HitData

Constructor & Destructor Documentation

HitLog()

CoreExport HitLog

(

)

Constructor.

The list of HitRecords is set to NULL.

~HitLog()

CoreExport ~HitLog

(

)

Destructor.

Clears the hit log.

Member Function Documentation

Clear()

CoreExport void Clear

(

)

Clears the log of hits by deleting the list of HitRecords.

ClearHitIndex()

CoreExport void ClearHitIndex ( bool  ready = false )

inline

{ hitIndex = 0; hitIndexReady = ready; }

IncrHitIndex()

CoreExport void IncrHitIndex ( )

inline

{ if (hitIndexReady) hitIndex++; else hitIndexReady = true; }

First()

HitRecord * First ( )

inline

Implemented by the System.

Returns the first HitRecord.

{ return first; }

ClosestHit()

CoreExport HitRecord * ClosestHit

(

)

Implemented by the System.

Returns the HitRecord that was 'closest' to the mouse position when hit testing was performed. This is the HitRecord with the minimum distance.

LogHit()

CoreExport void LogHit	(	INode *	nr,
		ModContext *	mc,
		DWORD	dist,
		ulong	info,
		HitData *	hitdata = NULL
	)

Implemented by the System.

This method is called to log a hit. It creates a new HitRecord object using the data passed and adds it to the hit log.

Parameters

nr	The node that was hit.
mc	The ModContext of the modifier.
dist	The 'distance' of the hit. An implementation defined value that is lower for hits that are closer.
info	Identifies the sub-object component that was hit.
hitdata	If the info field is insufficient to indicate the sub-object component that was hit, pass an instance of the HitData class that contains the needed information. Please Note, the system will own and therefore free the memory for this pointer. Do not attempt to free it.