SoLightPath Class Reference

The SoLightPath class is a light version of SoPath. More...

#include <Inventor/misc/SoLightPath.h>

Public Member Functions
	SoLightPath (SoNode *node, const int approxlength)
	SoLightPath (const int approxlength)
	~SoLightPath ()
void	setHead (SoNode *const node)
void	append (const int childindex)
void	push (const int childindex)
void	pop (void)
void	setTail (const int childindex)
SoNode *	getTail (void) const
SoNode *	getHead (void) const
SoNode *	getNode (const int index) const
int	getIndex (const int index) const
int	getFullLength () const
void	truncate (const int startindex)
void	makeTempPath (SoTempPath *path) const

Detailed Description

The SoLightPath class is a light version of SoPath.

SoLightPath can be used if you only need a temporary path, and don't want the overhead that comes with an SoPath (ref, unref, auditing etc).

It is your responsibility to make sure the path is valid before using it.

Constructor & Destructor Documentation

SoLightPath() [1/2]

SoLightPath::SoLightPath	(	SoNode *	headnodeptr,
		const int	approxlength
	)

A constructor. Supply the head node and the approximate length of the path.

SoLightPath() [2/2]

SoLightPath::SoLightPath

(

const int

approxlength

)

A constructor. Supply the appriximate length of the path.

~SoLightPath()

SoLightPath::~SoLightPath

(

)

Destructor.

Member Function Documentation

setHead()

void SoLightPath::setHead

(

SoNode *const

node

)

Sets head of path. Truncates path to length 1.

append()

void SoLightPath::append

(

const int

childindex

)

Appends a childindex to the path.

push()

void SoLightPath::push

(

const int

childindex

)

Same as append().

pop()

void SoLightPath::pop

(

void

)

Pops off the last child.

setTail()

void SoLightPath::setTail

(

const int

childindex

)

Sets the tail of the path.

getTail()

SoNode * SoLightPath::getTail

(

void

)

const

Returns the tail node of the path. Uses getNode().

getHead()

SoNode * SoLightPath::getHead

(

void

)

const

Returns the head node.

getNode()

SoNode * SoLightPath::getNode

(

const int

index

)

const

Returns the indexth node in path.

getIndex()

int SoLightPath::getIndex

(

const int

index

)

const

Returns the child index of the indexth node in the path.

getFullLength()

int SoLightPath::getFullLength

(

void

)

const

Returns the length of the path.

truncate()

void SoLightPath::truncate

(

const int

startindex

)

Truncates the path from startindex.

makeTempPath()

void SoLightPath::makeTempPath

(

SoTempPath *

path

)

const

Updates path to be the same path as this path.

---

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

• SoLightPath.h
• SoLightPath.cpp