soconedetail(3) [debian man page]
SoConeDetail(3) Coin SoConeDetail(3) NAME
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. SYNOPSIS
#include <Inventor/details/SoConeDetail.h> Inherits SoDetail. Public Member Functions virtual SoType getTypeId (void) const SoConeDetail (void) virtual ~SoConeDetail () virtual SoDetail * copy (void) const void setPart (const int part) int getPart (void) const Static Public Member Functions static SoType getClassTypeId (void) static void cleanupClass (void) static void initClass (void) Protected Attributes int part Additional Inherited Members Detailed Description 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. See also: SoCone, SoRayPickAction, SoCallbackAction Constructor &; Destructor Documentation SoConeDetail::SoConeDetail (void) Constructor. SoConeDetail::~SoConeDetail () [virtual] Destructor. Member Function Documentation SoType SoConeDetail::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 SoConeDetail::getClassTypeId (void) [static] Returns the type for this class. Reimplemented from SoDetail. void SoConeDetail::initClass (void) [static] Initialize relevant common data for all instances, like the type system. Reimplemented from SoDetail. SoDetail * SoConeDetail::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 SoConeDetail::setPart (const intpartarg) Set the part of a cone which was selected. A cone has two different conceptual parts; SoCone::SIDES or SoCone::BOTTOM. int SoConeDetail::getPart (void) const Returns selected cone part, either SoCone::SIDES or SoCone::BOTTOM. Member Data Documentation int SoConeDetail::part [protected] This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoConeDetail(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)