The SoNodeKitPath class presents the nodekit projection of a path. More...

#include <Inventor/SoNodeKitPath.h>

Inheritance diagram for SoNodeKitPath:

Public Member Functions
void	append (const SoNodeKitPath *fromPath)

void	append (SoBaseKit *childKit)

SbBool	containsNode (SoBaseKit *node) const

int	findFork (const SoNodeKitPath *path) const

int	getLength (void) const

SoNode *	getNode (const int idx) const

SoNode *	getNodeFromTail (const int idx) const

SoNode *	getTail (void) const

void	pop (void)

void	truncate (const int length)

Public Member Functions inherited from SoPath
	SoPath (const int approxlength=4)

	SoPath (const SoPath &rhs)

	SoPath (SoNode *const head)

void	append (const int childindex)

void	append (const SoPath *const frompath)

void	append (SoNode *const node)

SbBool	containsNode (const SoNode *const node) const

SbBool	containsPath (const SoPath *const path) const

SoPath *	copy (const int startfromnodeindex=0, int numnodes=0) const

int	findFork (const SoPath *const path) const

int	findNode (const SoNode *const node) const

SoFullPathView	fullPath (void) const

SoNode *	getHead (void) const

int	getIndex (const int index) const

int	getIndexFromTail (const int index) const

int	getLength (void) const

SoNode *	getNode (const int index) const

SoNode *	getNodeFromTail (const int index) const

SoNode *	getTail (void) const

SoType	getTypeId (void) const override
	Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

void	insertIndex (SoNode *const parent, const int newindex)

SbBool	isRelevantNotification (SoNotList *const l) const

SoNodeKitPathView	nodeKitPath (void) const

SoPath &	operator= (const SoPath &rhs)

void	pop (void)

void	push (const int childindex)

void	removeIndex (SoNode *const parent, const int oldindex)

void	replaceIndex (SoNode const parent, const int index, SoNode const newchild)

void	setHead (SoNode *const head)

void	truncate (const int length)

virtual void	write (SoWriteAction *action)

Public Member Functions inherited from SoBase
void	addAuditor (void *const auditor, const SoNotRec::Type type)

virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)

void	assertAlive (void) const

const SoAuditorList &	getAuditors (void) const

virtual SbName	getName (void) const

int32_t	getRefCount (void) const

SbBool	isOfType (SoType type) const
	Returns `TRUE` if the type of this object is either of the same type or inherited from type.

virtual void	notify (SoNotList *l)

void	ref (void) const

void	removeAuditor (void *const auditor, const SoNotRec::Type type)

virtual void	setName (const SbName &newname)

SbBool	shouldWrite (void)

virtual void	startNotify (void)

void	touch (void)

void	unref (void) const

void	unrefNoDelete (void) const

Static Public Member Functions
static SoNodeKitPath *	fromPath (const SoPath *path)

Static Public Member Functions inherited from SoPath
static SoPath *	getByName (const SbName name)

static int	getByName (const SbName name, SoPathList &l)

static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Static Public Member Functions inherited from SoBase
static void	addName (SoBase const base, const char const name)

static SbBool	connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)

static void	decrementCurrentWriteCounter (void)

static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

static SoBase *	getNamedBase (const SbName &name, SoType type)

static int	getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)

static SbBool	getTraceRefs (void)

static void	incrementCurrentWriteCounter (void)

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static SbBool	read (SoInput input, SoBase &base, SoType expectedtype)

static SbBool	readRoute (SoInput *input)

static void	removeName (SoBase const base, const char const name)

static void	setInstancePrefix (const SbString &c)

static void	setTraceRefs (SbBool trace)

Protected Member Functions
	SoNodeKitPath (const int approxLength)

virtual	~SoNodeKitPath ()

Protected Member Functions inherited from SoPath
virtual	~SoPath ()

void	auditPath (const SbBool flag)

Protected Member Functions inherited from SoBase
	SoBase (void)

virtual	~SoBase ()

virtual SoNotRec	createNotRec (void)

virtual void	destroy (void)

virtual const char *	getFileFormatName (void) const

SbBool	hasMultipleWriteRefs (void) const

void	writeFooter (SoOutput *out) const

SbBool	writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const

Additional Inherited Members
Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 }

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter (void)

static void	staticDataLock (void)

static void	staticDataUnlock (void)

Detailed Description

The SoNodeKitPath class presents the nodekit projection of a path.

Only nodekits are visible through the nodekit-specific accessors, while the complete route is retained.

Constructor & Destructor Documentation

◆ SoNodeKitPath()

SoNodeKitPath::SoNodeKitPath ( const int approxLength )

protected

A constructor.

◆ ~SoNodeKitPath()

SoNodeKitPath::~SoNodeKitPath ( )

protectedvirtual

The destructor.

Member Function Documentation

◆ append() [1/2]

void SoNodeKitPath::append ( const SoNodeKitPath * fromPath )

Appends the nodekit path to this path. Head of fromPath must be a part in the current tail.

◆ append() [2/2]

void SoNodeKitPath::append ( SoBaseKit * childKit )

Appends childKit to the path. childKit should be a part in the tail nodekit of this path. In effect, the path from the tail to first occurrence of childKit will be appended to the path.

◆ containsNode()

SbBool SoNodeKitPath::containsNode ( SoBaseKit * node ) const

Returns TRUE if node is in this path.

◆ findFork()

int SoNodeKitPath::findFork ( const SoNodeKitPath * path ) const

Returns the index of last common nodekit, or -1 if head node differs.

◆ fromPath()

SoNodeKitPath * SoNodeKitPath::fromPath ( const SoPath * path )

static

Materializes a genuine SoNodeKitPath containing an independent copy of the complete route in path. Returns NULL when path is NULL.

◆ getLength()

int SoNodeKitPath::getLength ( void ) const

Returns the number of nodekits in the complete route.

◆ getNode()

SoNode * SoNodeKitPath::getNode ( const int idx ) const

Returns nodekit number idx in path.

◆ getNodeFromTail()

SoNode * SoNodeKitPath::getNodeFromTail ( const int idx ) const

Returns nodekit number idx in the path, from the tail.

◆ getTail()

SoNode * SoNodeKitPath::getTail ( void ) const

Returns the tail of the path (the last nodekit in the path).

◆ pop()

void SoNodeKitPath::pop ( void )

Pops off the last nodekit (truncates at last tail).

◆ truncate()

void SoNodeKitPath::truncate ( const int length )

Truncates the path at nodekit number length.

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

SoNodeKitPath.h
SoNodeKitPath.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members