SoPickedPoint(3IV)

NAME
     SoPickedPoint (SoPickPt) - represents point on surface of picked object

INHERITS FROM
     SoPickedPoint

SYNOPSIS
     #include <Inventor_c/SoPickedPoint.h>

     typedef SoPickedPoint  SoPickPt

          Functions from class SoPickedPoint:

     SoPickedPoint *     SoPickPtCreate(const SoPickedPoint *pp)
     void                SoPickPtDelete(SoPickPt *this)
     const SbVec3f *     SoPickPtGetPt(const SoPickPt *this)
     const SbVec3f *     SoPickPtGetNorm(const SoPickPt *this)
     const SbVec4f *     SoPickPtGetTexCoords(const SoPickPt *this)
     int                 SoPickPtGetMtlInd(const SoPickPt *this)
     SoPath *            SoPickPtGetPath(const SoPickPt *this)
     SbBool              SoPickPtIsOnGeom(const SoPickPt *this)
     const SoDetail *    SoPickPtGetDtl(const SoPickPt *this, const SoNode
                              *node = NULL)
     const SbMatrix      SoPickPtGetObjToWorld(const SoPickPt *this, const
                              SoNode *node = NULL)
     const SbMatrix      SoPickPtGetWorldToObj(const SoPickPt *this, const
                              SoNode *node = NULL)
     const SbMatrix      SoPickPtGetObjToImage(const SoPickPt *this, const
                              SoNode *node = NULL)
     const SbMatrix      SoPickPtGetImageToObj(const SoPickPt *this, const
                              SoNode *node = NULL)
     const SbVec3f       SoPickPtGetObjPt(const SoPickPt *this, const SoNode
                              *node = NULL)
     const SbVec3f       SoPickPtGetObjNorm(const SoPickPt *this, const SoNode
                              *node = NULL)
     const SbVec4f       SoPickPtGetObjTexCoords(const SoPickPt *this, const
                              SoNode *node=NULL)


DESCRIPTION
     An SoPickedPoint represents a point on the surface of an object that was
     picked by applying an SoRayPickAction to a scene. It contains a path to
     the picked shape, the point of intersection, the surface normal and
     texture coordinates at that point, and other information.

     Each node in the picked path may have a corresponding instance of a
     detail subclass. These detail instances are stored in the SoPickedPoint.

FUNCTIONS
     SoPickedPoint *     SoPickPtCreate(const SoPickedPoint *pp)
          Copy constructor.

     void                SoPickPtDelete(SoPickPt *this)
          Destructor.

     const SbVec3f *     SoPickPtGetPt(const SoPickPt *this)
     const SbVec3f *     SoPickPtGetNorm(const SoPickPt *this)
     const SbVec4f *     SoPickPtGetTexCoords(const SoPickPt *this)
          These return the intersection point and surface normal in world
          space, and the texture coordinates in image space.

     int                 SoPickPtGetMtlInd(const SoPickPt *this)
          Returns the index into the current set of materials of the material
          active at the intersection point. Note that if the materials are
          interpolated between vertices, the index will correspond to the
          material at one of the vertices.

     SoPath *            SoPickPtGetPath(const SoPickPt *this)
          Returns the path to the object that was intersected.

     SbBool              SoPickPtIsOnGeom(const SoPickPt *this)
          Returns whether the intersection is actually on the geometry of the
          character that was hit, as opposed to being on the bounding box. The
          pick style (see SoPickStyle) affects this decision.

     const SoDetail *    SoPickPtGetDtl(const SoPickPt *this, const SoNode
                              *node = NULL)
          Returns the detail that corresponds to the given node in the path
          returned by  SoPickPtGetPath(). If the node pointer is NULL (the
          default), the detail corresponding to the tail of the (full) path is
          returned.

     const SbMatrix      SoPickPtGetObjToWorld(const SoPickPt *this, const
                              SoNode *node = NULL)
     const SbMatrix      SoPickPtGetWorldToObj(const SoPickPt *this, const
                              SoNode *node = NULL)
          These return the transformation matrices between world space and the
          object space corresponding to the given node in the path. If the
          node pointer is NULL (the default), the matrix corresponding to the
          tail of the (full) path is returned.

     const SbMatrix      SoPickPtGetObjToImage(const SoPickPt *this, const
                              SoNode *node = NULL)
     const SbMatrix      SoPickPtGetImageToObj(const SoPickPt *this, const
                              SoNode *node = NULL)
          These return the texture transformation matrices between image space
          and the object space corresponding to the given node in the path. If
          the node pointer is NULL (the default), the matrix corresponding to
          the tail of the (full) path is returned.

     const SbVec3f       SoPickPtGetObjPt(const SoPickPt *this, const SoNode
                              *node = NULL)
     const SbVec3f       SoPickPtGetObjNorm(const SoPickPt *this, const SoNode
                              *node = NULL)
     const SbVec4f       SoPickPtGetObjTexCoords(const SoPickPt *this, const
                              SoNode *node=NULL)
          These return the intersection point, surface normal, and texture
          coordinates in the object space corresponding to the given node in
          the path. If the node pointer is NULL (the default), the information
          corresponding to the tail of the (full) path is returned.


SEE ALSO
     SoRayPickAction, SoPickStyle, SoDetail, SoPath