details(3) [debian man page]
Detail Classes(3) Coin Detail Classes(3) NAME
Detail Classes - Classes class SoConeDetail The SoConeDetail class contains information about the parts of a SoCone shape. Instances of this class are used for storing information about hit points on cone geometry after pick operations, and for storing information returned to tessellation callbacks. " class SoCubeDetail The SoCubeDetail class contains information about the parts of a SoCube shape. Instances of this class are used for storing information about hit points on cone geometry after pick operations, and for storing information returned to tessellation callbacks. " class SoCylinderDetail The SoCylinderDetail class contains information about the parts of a SoCylinder shape. Instances of this class are used for storing information about hit points on cylinder geometry after pick operations, and for storing information returned to tessellation callbacks. " class SoDetail The SoDetail class is the superclass for all classes storing detailed information about particular shapes. Detail information about shapes is used in relation to picking actions in Coin. They typically contain the relevant information about what particular part of the shape a pick ray intersected with. " class SoFaceDetail The SoFaceDetail class is for storing detailed polygon information. Instances of this class are used among other things for storing information about polygons after pick operations, and for storing information returned to tessellation callbacks. " class SoLineDetail The SoLineDetail class is for storing detailed 3D line information. Instances of this class are used among other things for storing information about lines after pick operations, and for storing information returned to tessellation callbacks. " class 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. " class SoPointDetail The SoPointDetail class is for storing detailed information for a single 3D point. Instances of this class are used among other things for storing information about the vertices of lines and polygons after pick operations, and for storing information returned to tessellation callbacks. " class SoTextDetail The SoTextDetail stores information about a character in a string. Instances of this class are used for storing information about hit points on textual 2D or 3D geometry after pick operations, and for storing information returned to tessellation callbacks. " class SoDetailList The SoDetailList class is a container for pointers to SoDetail objects. This list class will delete the details when destructed/truncated, or when a detail in the list is replaced by another detail. The caller is responsible for allocating the details passed to the list, but should not deallocate them since this will be handled by the list. " Detailed Description Detail classes are objects that deliver additional information wherever the SoPrimitiveVertex class is used. This goes for ray picking results, and it also goes for primitive generation by SoShape classes for the SoCallbackAction class and fallback shape rendering through primitive generation (a useful debugging trick when debugging for instance raypicking). Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 Detail Classes(3)
Check Out this Related Man Page
SoTextDetail(3) Coin SoTextDetail(3) NAME
SoTextDetail - The SoTextDetail stores information about a character in a string. Instances of this class are used for storing information about hit points on textual 2D or 3D geometry after pick operations, and for storing information returned to tessellation callbacks. SYNOPSIS
#include <Inventor/details/SoTextDetail.h> Inherits SoDetail. Public Member Functions virtual SoType getTypeId (void) const SoTextDetail (void) virtual ~SoTextDetail () virtual SoDetail * copy (void) const int getStringIndex (void) const int getCharacterIndex (void) const int getPart (void) const void setStringIndex (const int idx) void setCharacterIndex (const int idx) void setPart (const int idx) Static Public Member Functions static SoType getClassTypeId (void) static void cleanupClass (void) static void initClass (void) Additional Inherited Members Detailed Description The SoTextDetail stores information about a character in a string. Instances of this class are used for storing information about hit points on textual 2D or 3D geometry after pick operations, and for storing information returned to tessellation callbacks. See also: SoRayPickAction, SoCallbackAction SoText3, SoText2, SoAsciiText Constructor &; Destructor Documentation SoTextDetail::SoTextDetail (void) Constructor sets up an 'empty' detail; all indices are set to -1 to indicate this. SoTextDetail::~SoTextDetail () [virtual] Destructor. This class does not allocate any extra resources, so no actions are taken. Member Function Documentation SoType SoTextDetail::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 SoTextDetail::getClassTypeId (void) [static] Returns the type for this class. Reimplemented from SoDetail. void SoTextDetail::initClass (void) [static] Initialize relevant common data for all instances, like the type system. Reimplemented from SoDetail. SoDetail * SoTextDetail::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. int SoTextDetail::getStringIndex (void) const Returns the index of the string where a character was hit / generated, from a set of multiple strings. See also: SoMFString int SoTextDetail::getCharacterIndex (void) const Returns the index of the character in the string which was hit. See also: getStringIndex() int SoTextDetail::getPart (void) const For SoText3, returns the part id of the text geometry. The id numbers matches those specified in the SoText3::Part enumeration. void SoTextDetail::setStringIndex (const intidx) Internal method for 'client' shape nodes to initialize this SoTextDetail instance. void SoTextDetail::setCharacterIndex (const intidx) Internal method for 'client' shape nodes to initialize this SoTextDetail instance. void SoTextDetail::setPart (const intpartarg) Internal method for 'client' shape nodes to initialize this SoTextDetail instance. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoTextDetail(3)