Detailed Description

This class provides a representation of a ladder, including its base, top, orientation, and entry/exit points. It processes navigation ladder data to determine the locations where a human entity can mount or dismount the ladder, as well as the ladder's physical characteristics like pitch, heading and length.

#include <ladder.h>

Public Member Functions
	DtLadder ()

virtual	~DtLadder ()

	DtLadder (const DtLadder &orig)

DtLadder &	operator= (const DtLadder &orig)

virtual bool	operator== (const DtLadder &other)

virtual void	init (const DtNavLadder &navLadder, DtPhysicalWorld *physicalWorld)

virtual DtVector	base () const

virtual DtVector	baseEntryExit () const

virtual DtVector	top () const

virtual DtVector	topEntryExit () const

virtual double	heading () const

virtual double	pitch () const

virtual double	length () const

virtual DtDcm	localOrientation () const

Protected Member Functions
virtual void	calculateBaseTopAndOrientation ()

Protected Attributes
std::vector< DtVector >	myLocalPointsOnLadder

std::vector< DtVector >	myLocalLadderEntryExitPoints

int	myBaseIndex

int	myTopIndex

double	myHeading

double	myPitch

double	myLength

DtDcm	myLocalOrientation

DtPhysicalWorld *	myPhysicalWorld

Constructor & Destructor Documentation

◆ DtLadder() [1/2]

makVre::DtLadder::DtLadder ( )

Default constructor.

Creates a new ladder representation with default values. Must be initialized with init() before use.

Referenced by DtLadder(), operator=(), and operator==().

◆ ~DtLadder()

virtual makVre::DtLadder::~DtLadder ( )

virtual

Virtual destructor.

Cleans up resources used by the ladder representation.

◆ DtLadder() [2/2]

makVre::DtLadder::DtLadder ( const DtLadder & orig )

Copy constructor.

Parameters

orig	The source ladder to copy from

Creates a new ladder representation as a copy of the provided original.

References DtLadder().

Member Function Documentation

◆ operator=()

DtLadder & makVre::DtLadder::operator= ( const DtLadder & orig )

Assignment operator.

Parameters

orig	The source ladder to copy from

Returns: Reference to this ladder after assignment

Assigns the contents of the provided ladder to this one.

References DtLadder().

◆ operator==()

virtual bool makVre::DtLadder::operator== ( const DtLadder & other )

virtual

Equivalence operator.

Parameters

other The ladder to compare with

Returns: True if the ladders are equivalent, false otherwise

Compares this ladder with another to determine if they are equivalent.

References DtLadder().

◆ init()

virtual void makVre::DtLadder::init	(	const DtNavLadder &	navLadder,
		DtPhysicalWorld *	physicalWorld )

virtual

Initializes the ladder from navigation data.

Parameters

navLadder	The navigation ladder data to initialize from
physicalWorld	Pointer to the physical world for terrain queries

Initializes this ladder representation based on the provided navigation ladder data and physical world. This calculates the ladder's base, top, orientation, and entry/exit points.

◆ base()

virtual DtVector makVre::DtLadder::base ( ) const

virtual

Gets the ladder base position.

Returns: The position of the ladder's base in local coordinates

Returns the position where the bottom of the ladder contacts the ground.

◆ baseEntryExit()

virtual DtVector makVre::DtLadder::baseEntryExit ( ) const

virtual

Gets the ladder base entry/exit point.

Returns: The position where an entity would enter/exit at the ladder's base

Returns the position where an entity would stand to mount or dismount the ladder at its base.

◆ top()

virtual DtVector makVre::DtLadder::top ( ) const

virtual

Gets the ladder top position.

Returns: The position of the ladder's top in local coordinates

Returns the position of the top end of the ladder.

◆ topEntryExit()

virtual DtVector makVre::DtLadder::topEntryExit ( ) const

virtual

Gets the ladder top entry/exit point.

Returns: The position where an entity would enter/exit at the ladder's top

Returns the position where an entity would stand to mount or dismount the ladder at its top.

◆ heading()

virtual double makVre::DtLadder::heading ( ) const

virtual

Gets the ladder heading.

Returns: The heading angle in radians

Returns the heading angle of the ladder in radians. This represents the direction the ladder is facing when viewed from above.

◆ pitch()

virtual double makVre::DtLadder::pitch ( ) const

virtual

Gets the ladder pitch.

Returns: The pitch angle in radians

Returns the pitch angle of the ladder in radians. This represents the steepness of the ladder relative to the ground.

◆ length()

virtual double makVre::DtLadder::length ( ) const

virtual

Gets the ladder length.

Returns: The length of the ladder in meters

Returns the total length of the ladder from base to top.

◆ localOrientation()

virtual DtDcm makVre::DtLadder::localOrientation ( ) const

virtual

Gets the ladder orientation matrix.

Returns: The direction cosine matrix representing the ladder's orientation

Returns a direction cosine matrix representing the ladder's orientation in local coordinates.

◆ calculateBaseTopAndOrientation()

virtual void makVre::DtLadder::calculateBaseTopAndOrientation ( )

protectedvirtual

Calculates ladder properties from point data.

Internal method that calculates the ladder's base, top, heading, pitch, length, and orientation based on the ladder points.

Member Data Documentation

◆ myLocalPointsOnLadder

std::vector<DtVector> makVre::DtLadder::myLocalPointsOnLadder

protected

Ordered list of points on the ladder.

Stores points along the ladder in local (database) coordinates.

◆ myLocalLadderEntryExitPoints

std::vector<DtVector> makVre::DtLadder::myLocalLadderEntryExitPoints

protected

Ordered list of entry/exit points.

Stores points near the ladder on the terrain in local coordinates, where an entity would stand to mount or dismount the ladder. Has one-to-one correspondence with myLocalPointsOnLadder.

◆ myBaseIndex

int makVre::DtLadder::myBaseIndex

protected

Index of the base point in the points array.

Stores the index of the base point within myLocalPointsOnLadder.

◆ myTopIndex

int makVre::DtLadder::myTopIndex

protected

Index of the top point in the points array.

Stores the index of the top point within myLocalPointsOnLadder.

◆ myHeading

double makVre::DtLadder::myHeading

protected

The ladder heading in radians.

Stores the heading angle of the ladder in radians.

◆ myPitch

double makVre::DtLadder::myPitch

protected

The ladder pitch in radians.

Stores the pitch angle of the ladder in radians.

◆ myLength

double makVre::DtLadder::myLength

protected

The ladder length in meters.

Stores the total length of the ladder from base to top.

◆ myLocalOrientation

DtDcm makVre::DtLadder::myLocalOrientation

protected

The ladder orientation matrix.

Stores a direction cosine matrix representing the ladder's orientation in local coordinates.

◆ myPhysicalWorld

DtPhysicalWorld* makVre::DtLadder::myPhysicalWorld

protected

Pointer to the physical world.

Stores a pointer to the physical world used for terrain queries.

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

include/vrfExtensions/vreVrfobjcore/ladder.h

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ DtLadder() [1/2]

◆ ~DtLadder()

◆ DtLadder() [2/2]

Member Function Documentation

◆ operator=()

◆ operator==()

◆ init()

◆ base()

◆ baseEntryExit()

◆ top()

◆ topEntryExit()

◆ heading()

◆ pitch()

◆ length()

◆ localOrientation()

◆ calculateBaseTopAndOrientation()

Member Data Documentation

◆ myLocalPointsOnLadder

◆ myLocalLadderEntryExitPoints

◆ myBaseIndex

◆ myTopIndex

◆ myHeading

◆ myPitch

◆ myLength

◆ myLocalOrientation

◆ myPhysicalWorld