Class to manage collisions between the camera and the scene. More...

#include <Inventor/Xt/viewers/SoXtCollisionViewer.h>

Public Types
typedef void	SoXtCollisionViewerCB(void userData, SoXtCollisionViewer collisionViewer)

Public Member Functions
	SoXtCollisionViewer (SoXtViewer *viewer)
	Constructor.

	~SoXtCollisionViewer ()
	Destructor.

SoXtViewer *	getViewer () const
	Gets the original viewer.

void	setDistance (float distance)
	Sets the distance between the camera and the objects.

float	getDistance () const
	Gets the distance between the camera and the objects.

void	setNumSteps (int num_steps)
	Sets the number of steps to be used in the collision computation.

int	getNumSteps () const
	Gets the number of steps to be used in the collision computation.

void	setCollisionDetection (SbBool value=TRUE)
	Sets the collision detection flag.

SbBool	getCollisionDetection () const
	Gets the collision detection flag.

void	setZBufferOptimization (SbBool value=TRUE, SbBool useZBufferOnly=FALSE)
	Sets the Z buffer optimization flag.

SbBool	getZBufferOptimistation () const
	Gets the Z buffer optimization flag.

void	addCallback (SoXtCollisionViewerCB f, void ud=NULL)
	Adds a callback.

void	removeCallback (SoXtCollisionViewerCB f, void ud=NULL)
	Removes the callback.

Detailed Description

Class to manage collisions between the camera and the scene.

This class is used to constrain a viewer, preventing the viewer's camera from colliding with the objects in the scene. It overrides the RenderCallback on the viewer that it's attached to.

The programmer can define the maximum distance between the camera and the objects.

When Z-buffer optimization is enabled, the algorithm looks at the Z-buffer to see if there is an object in front of the camera when the user moves forward, and an SoIntersectionDetectionAction when the user moves backward.

NOTE: This class is not a viewer.

Member Typedef Documentation

◆ SoXtCollisionViewerCB

typedef void SoXtCollisionViewerCB(void *userData, SoXtCollisionViewer *collisionViewer)

Definition at line 45 of file SoXtCollisionViewer.h.

Constructor & Destructor Documentation

◆ SoXtCollisionViewer()

SoXtCollisionViewer::SoXtCollisionViewer ( SoXtViewer * viewer )

Constructor.

◆ ~SoXtCollisionViewer()

SoXtCollisionViewer::~SoXtCollisionViewer ( )

Destructor.

Member Function Documentation

◆ addCallback()

void SoXtCollisionViewer::addCallback	(	SoXtCollisionViewerCB *	f,
		void *	ud = `NULL`
	)

Adds a callback.

This callback is called when a collision occurs between the camera and the scene.

◆ getCollisionDetection()

SbBool SoXtCollisionViewer::getCollisionDetection ( ) const

Gets the collision detection flag.

◆ getDistance()

float SoXtCollisionViewer::getDistance ( ) const

Gets the distance between the camera and the objects.

◆ getNumSteps()

int SoXtCollisionViewer::getNumSteps ( ) const

Gets the number of steps to be used in the collision computation.

◆ getViewer()

SoXtViewer * SoXtCollisionViewer::getViewer ( ) const

Gets the original viewer.

◆ getZBufferOptimistation()

SbBool SoXtCollisionViewer::getZBufferOptimistation ( ) const

Gets the Z buffer optimization flag.

◆ removeCallback()

void SoXtCollisionViewer::removeCallback	(	SoXtCollisionViewerCB *	f,
		void *	ud = `NULL`
	)

Removes the callback.

◆ setCollisionDetection()

void SoXtCollisionViewer::setCollisionDetection ( SbBool value = TRUE )

Sets the collision detection flag.

The default value is TRUE.

◆ setDistance()

void SoXtCollisionViewer::setDistance ( float distance )

Sets the distance between the camera and the objects.

◆ setNumSteps()

void SoXtCollisionViewer::setNumSteps ( int num_steps )

Sets the number of steps to be used in the collision computation.

The default number of steps is 4. The minimum value is 2.

◆ setZBufferOptimization()

void SoXtCollisionViewer::setZBufferOptimization	(	SbBool	value = `TRUE`,
		SbBool	useZBufferOnly = `FALSE`
	)

Sets the Z buffer optimization flag.