sonodekitpath(3) [debian man page]
SoNodeKitPath(3) Coin SoNodeKitPath(3) NAME
SoNodeKitPath - The SoNodeKitPath class is a path that contains only nodekit nodes. All other nodes are hidden from the user. SYNOPSIS
#include <Inventor/SoNodeKitPath.h> Inherits SoPath. Public Member Functions int getLength (void) const SoNode * getTail (void) const SoNode * getNode (const int idx) const SoNode * getNodeFromTail (const int idx) const void truncate (const int length) void pop (void) void append (SoBaseKit *childKit) void append (const SoNodeKitPath *fromPath) SbBool containsNode (SoBaseKit *node) const int findFork (const SoNodeKitPath *path) const Protected Member Functions SoNodeKitPath (const int approxLength) virtual ~SoNodeKitPath () Friends int operator== (const SoNodeKitPath &p1, const SoNodeKitPath &p2) Additional Inherited Members Detailed Description The SoNodeKitPath class is a path that contains only nodekit nodes. All other nodes are hidden from the user. Constructor &; Destructor Documentation SoNodeKitPath::SoNodeKitPath (const intapproxLength) [protected] A constructor. SoNodeKitPath::~SoNodeKitPath () [protected], [virtual] The destructor. Member Function Documentation int SoNodeKitPath::getLength (void) const Returns the length of the path (the number of nodekit nodes). Reimplemented from SoPath. SoNode * SoNodeKitPath::getTail (void) const Returns the tail of the path (the last nodekit in the path). Reimplemented from SoPath. SoNode * SoNodeKitPath::getNode (const intidx) const Returns nodekit number idx in path. Reimplemented from SoPath. SoNode * SoNodeKitPath::getNodeFromTail (const intidx) const Returns nodekit number idx in the path, from the tail. Reimplemented from SoPath. void SoNodeKitPath::truncate (const intlength) Truncates the path at nodekit number length. Reimplemented from SoPath. void SoNodeKitPath::pop (void) Pops off the last nodekit (truncates at last tail). Reimplemented from SoPath. 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 occurrance of childKit will be appended to the path. void SoNodeKitPath::append (const SoNodeKitPath *fromPath) Appends the nodekit path to this path. Head of fromPath must be a part in the current tail. SbBool SoNodeKitPath::containsNode (SoBaseKit *node) const Returns TRUE if node is in this path. int SoNodeKitPath::findFork (const SoNodeKitPath *path) const Returns the index of last common nodekit, or -1 if head node differs. Friends And Related Function Documentation int operator== (const SoNodeKitPath &p1, const SoNodeKitPath &p2) [friend] Returns TRUE if paths are equal, FALSE otherwise. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoNodeKitPath(3)
Check Out this Related Man Page
SoNodeKitDetail(3) Coin SoNodeKitDetail(3) NAME
SoNodeKitDetail - The SoNodeKitDetail class is yet to be documented. When a pick action is executed and geometry within a nodekit is hit, the nodekit generates an SoNodeKitDetail object which contains information about the specific part inside the nodekit hit by the pick ray. SYNOPSIS
#include <Inventor/details/SoNodeKitDetail.h> Inherits SoDetail. Public Member Functions virtual SoType getTypeId (void) const SoNodeKitDetail (void) virtual ~SoNodeKitDetail () virtual SoDetail * copy (void) const void setNodeKit (SoBaseKit *kit) SoBaseKit * getNodeKit (void) const void setPart (SoNode *part) SoNode * getPart (void) const void setPartName (const SbName &name) const SbName & getPartName (void) const Static Public Member Functions static SoType getClassTypeId (void) static void cleanupClass (void) static void initClass (void) Protected Attributes SoBaseKit * myNodeKit SoNode * myPart SbName myPartName Additional Inherited Members Detailed Description The SoNodeKitDetail class is yet to be documented. When a pick action is executed and geometry within a nodekit is hit, the nodekit generates an SoNodeKitDetail object which contains information about the specific part inside the nodekit hit by the pick ray. See also: SoRayPickAction Constructor &; Destructor Documentation SoNodeKitDetail::SoNodeKitDetail (void) Constructor. SoNodeKitDetail::~SoNodeKitDetail () [virtual] Destructor. Member Function Documentation SoType SoNodeKitDetail::getTypeId (void) const [virtual] Returns the type identification of a detail derived from a class inheriting SoDetail. This is used for run-time type checking and 'downward' casting. Usage example: void fuhbear(SoDetail * detail) { if (detail->getTypeId() == SoFaceDetail::getClassTypeId()) { // safe downward cast, know the type SoFaceDetail * facedetail = (SoFaceDetail *)detail; } return; // ignore if not a SoFaceDetail } For application programmers wanting to extend the library with new detail classes: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre- defined macros available through Inventor/nodes/SoSubDetail.h: SO_DETAIL_SOURCE and SO_DETAIL_INIT_CLASS. Implements SoDetail. SoType SoNodeKitDetail::getClassTypeId (void) [static] Returns the type for this class. Reimplemented from SoDetail. void SoNodeKitDetail::initClass (void) [static] Initialize relevant common data for all instances, like the type system. Reimplemented from SoDetail. SoDetail * SoNodeKitDetail::copy (void) const [virtual] Return a deep copy of ourself. Note that if the Coin library has been built as a DLL under Microsoft Windows and you use this method from application code, you must make sure that both the Coin DLL and the application executable is using the same instance of a C Run-Time (CRT) library. Otherwise, you will get memory heap corruption upon deallocating the returned instances, eventually leading to mysterious crashes. Implements SoDetail. void SoNodeKitDetail::setNodeKit (SoBaseKit *kit) Set the pointer indicating which nodekit generated this detail object. SoBaseKit * SoNodeKitDetail::getNodeKit (void) const Returns a pointer to the nodekit generating this details object. void SoNodeKitDetail::setPart (SoNode *part) Set the pointer indicating which node inside the nodekit was hit by a pick. SoNode * SoNodeKitDetail::getPart (void) const Return node inside nodekit which was hit. void SoNodeKitDetail::setPartName (const SbName &name) Set catalog name of node part which was hit. const SbName & SoNodeKitDetail::getPartName (void) const Return catalog name of nodekit part which was hit. Member Data Documentation SoBaseKit * SoNodeKitDetail::myNodeKit [protected] The nodekit generating this details object. SoNode * SoNodeKitDetail::myPart [protected] Node inside nodekit which was hit. SbName SoNodeKitDetail::myPartName [protected] Catalog name of nodekit part which was hit. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoNodeKitDetail(3)