Open Inventor Reference
SoPickRayElement Class Reference

Element that stores the current ray to use for picking. More...

#include <Inventor/elements/SoPickRayElement.h>

Inheritance diagram for SoPickRayElement:
SoElement

Public Member Functions

virtual void init (SoState *state)
 Initializes element. More...
 
virtual bool matches (const SoElement *elt) const
 Always returns FALSE, since this element should never be a criterion for cache invalidation. More...
 
virtual SoElementcopyMatchInfo () const
 Create and return a copy of this element. More...
 
virtual void print (FILE *fp) const
 Prints element (for debugging) More...
 
- Public Member Functions inherited from SoElement
virtual void push (SoState *state)
 Pushes/pops element. More...
 
virtual void pop (SoState *state, const SoElement *prevTopElement)
 
SoType getTypeId () const
 Returns type identifier for element instance. More...
 
int getStackIndex () const
 Returns the stack index for an element instance. More...
 
void setDepth (int dpth)
 Sets stuff in an element instance. More...
 
void setNext (SoElement *nxt)
 
void setNextInStack (SoElement *nxt)
 
void setNextFree (SoElement *nxt)
 
int getDepth () const
 Returns stuff from element instance. More...
 
SoElementgetNext () const
 
virtual ~SoElement ()
 Destructor. More...
 

Static Public Member Functions

static void set (SoState *state, const SbViewVolume &volume)
 Sets the picking ray. More...
 
static const SbViewVolumeget (SoState *state)
 Returns the current picking ray view volume from the state. More...
 
static void initClass ()
 Initializes the SoPickRayElement class. More...
 
- Static Public Member Functions inherited from SoElement
static SoType getClassTypeId ()
 Returns type identifier for SoElement class. More...
 
static void initElements ()
 Initialize ALL Inventor element classes. More...
 
static void initClass ()
 Initializes the SoElement class. More...
 
static int getNumStackIndices ()
 Returns the number of stack indices allocated. More...
 
static SoType getIdFromStackIndex (int stackIndex)
 Returns the id for the element with the given stack index. More...
 

Protected Member Functions

virtual ~SoPickRayElement ()
 
- Protected Member Functions inherited from SoElement
 SoElement ()
 Constructor; use typeId.createInstance to create elements. More...
 
void capture (SoState *state) const
 Does whatever is necessary in state to capture this element for caching purposes. More...
 
virtual void captureThis (SoState *state) const
 Really captures this element, once it has been determined that a cache is open to capture it. More...
 
void setTypeId (SoType id)
 Sets typeId in instance. More...
 
void setStackIndex (int index)
 Sets stackIndex in instance. More...
 
SoElementgetNextInStack () const
 Returns next instance in specific element stack. More...
 
SoElementgetNextFree () const
 Returns next free element in a specific element stack. More...
 

Protected Attributes

SbViewVolume volume
 Ray as view volume. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from SoElement
static SoElementgetElement (SoState *state, int stackIndex)
 Returns an instance of an element from the stack with the given index in the given state. More...
 
static const SoElementgetConstElement (SoState *state, int stackIndex)
 Returns a read-only pointer to the top instance in the given element stack. More...
 
static int createStackIndex (SoType id)
 Creates and returns a new stack index. More...
 
- Static Protected Attributes inherited from SoElement
static int classStackIndex
 Stack index for SoElement class. More...
 

Detailed Description

It contains the world space ray information in terms of an SbViewVolume. The projection point and view direction of the volume represent the ray itself. The width (which equals the height) represents the diameter of the picking circle in the near plane. The near and far planes represent the distances to the near and far planes between which valid intersections must lie.

Definition at line 76 of file SoPickRayElement.h.

Constructor & Destructor Documentation

◆ ~SoPickRayElement()

virtual SoPickRayElement::~SoPickRayElement ( )
protectedvirtual

Member Function Documentation

◆ copyMatchInfo()

virtual SoElement* SoPickRayElement::copyMatchInfo ( ) const
virtual

Implements SoElement.

◆ get()

static const SbViewVolume& SoPickRayElement::get ( SoState state)
static

◆ init()

virtual void SoPickRayElement::init ( SoState state)
virtual

Reimplemented from SoElement.

◆ initClass()

static void SoPickRayElement::initClass ( )
static

◆ matches()

virtual bool SoPickRayElement::matches ( const SoElement elt) const
virtual

Implements SoElement.

◆ print()

virtual void SoPickRayElement::print ( FILE *  fp) const
virtual

Reimplemented from SoElement.

◆ set()

static void SoPickRayElement::set ( SoState state,
const SbViewVolume volume 
)
static

Member Data Documentation

◆ volume

SbViewVolume SoPickRayElement::volume
protected

Definition at line 105 of file SoPickRayElement.h.


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