gzIntersector.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzIntersector.h
// Module       : 
// Description  : Class definition of the gzIntersector class
// Author       : Anders Modén      
// Product      : Gizmo3D 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden   
//          
// NOTE:    Gizmo3D is a high performance 3D Scene Graph and effect visualisation 
//          C++ toolkit for Linux, Mac OS X, Windows (Win32) and IRIX® for  
//          usage in Game or VisSim development.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  000828  Created file    
//
//******************************************************************************
#ifndef __GZ_INTERSECTOR_H__
#define __GZ_INTERSECTOR_H__

#include "gzScene.h"
#include "gzContext.h"

enum gzIntersectQuery
{   
    GZ_INTERSECTOR_NEAREST_POINT            =   (1<<0),
    GZ_INTERSECTOR_NORMAL                   =   (1<<1),
    GZ_INTERSECTOR_NODE                     =   (1<<2),
    GZ_INTERSECTOR_HISTORY                  =   (1<<3), 
    GZ_INTERSECTOR_ABC_TRI                  =   (1<<4),
    GZ_INTERSECTOR_ALL_HITS                 =   (1<<5),
};

GZ_USE_BIT_LOGIC(gzIntersectQuery);


class gzIntersectorResult
{
public:

    gzVec3                  coordinate;

    gzVec3                  a,b,c;

    gzVec3                  normal;

    gzRefPointer<gzNode>    node;

    gzList<gzNode>          history;

    gzULong                 resultmask;
};

class gzIntersector;

class gzIntersectorAction : public gzTraverseAction
{
public:
    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    GZ_GRAPH_EXPORT gzIntersectorAction(gzIntersector *intersector=NULL);

    GZ_GRAPH_EXPORT virtual ~gzIntersectorAction(){};

    GZ_GRAPH_EXPORT gzVoid action(gzNode *node , gzContext *context);

    GZ_GRAPH_EXPORT gzVoid setIntersector(gzIntersector *intersector);

    GZ_GRAPH_EXPORT gzIntersector *getIntersector()                 { return m_intersector; }

    GZ_GRAPH_EXPORT const gzVec3 & getStartPos()            const   { return m_transformedStartPos; } 
    GZ_GRAPH_EXPORT const gzVec3 & getDirection()           const   { return m_transformedDirection; }

    GZ_GRAPH_EXPORT const gzList<gzNode> & getHistory()     const   { return m_history; };

protected:

    GZ_GRAPH_EXPORT virtual gzBool checkBoundary(gzContext *context, gzNode *node);
    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzNode *node , gzContext *context);
    GZ_GRAPH_EXPORT virtual gzVoid postTraverseAction( gzNode *node , gzContext *context);

private:

    gzIntersector *     m_intersector;
                        
    gzULong             m_currentTransformIndex;
                        
    gzVec3              m_transformedStartPos;
    gzVec3              m_transformedDirection;

    gzQueue<gzVec3>     m_transformedStartPosStorage;               
    gzQueue<gzVec3>     m_transformedDirectionStorage;


    gzList<gzNode>      m_history;
};


//******************************************************************************
// Class    : gzIntersector
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  000828  Created 
//                                  
//******************************************************************************
class gzIntersector : public gzObject , public gzNameInterface , public gzIntersectMask
{
public:

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    GZ_GRAPH_EXPORT gzIntersector(const gzString & name=GZ_EMPTY_STRING);
    GZ_GRAPH_EXPORT virtual ~gzIntersector(){};

    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    // ---------- intersector interface ---------------------------------

    GZ_GRAPH_EXPORT gzVoid setBaseTransform(const gzMatrix4 &baseTransform);
    GZ_GRAPH_EXPORT gzVoid setProjectionTransform(const gzMatrix4 &projectionTransform);

    GZ_GRAPH_EXPORT gzVoid setStartPosition(const gzVec3 &position);
    GZ_GRAPH_EXPORT gzVoid setDirection(const gzVec3 &direction);

    GZ_GRAPH_EXPORT gzVoid clearIntersector();
    
    GZ_GRAPH_EXPORT gzBool intersect(gzNode *node,gzIntersectQuery queryType=GZ_INTERSECTOR_NEAREST_POINT,gzFloat lodFactor=1.0);

    // ---------- intersector data --------------------------------------

    GZ_PROPERTY_GET_EXPORT( gzBool          ,   HasBaseTransform        , GZ_GRAPH_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzBool          ,   HasProjectionTransform  , GZ_GRAPH_EXPORT);

    GZ_PROPERTY_GET_EXPORT( gzMatrix4       ,   ProjectionTransform     , GZ_GRAPH_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzMatrix4       ,   InvProjectionTransform  , GZ_GRAPH_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzMatrix4       ,   BaseTransform           , GZ_GRAPH_EXPORT);
    GZ_PROPERTY_GET_EXPORT( gzMatrix4       ,   InvBaseTransform        , GZ_GRAPH_EXPORT);

    // ---------- query results -----------------------------------------

    GZ_GRAPH_EXPORT gzDynamicArray<gzIntersectorResult> getResult();

    GZ_GRAPH_EXPORT gzIntersectQuery getQueryType();

    GZ_GRAPH_EXPORT gzVoid addResult(const gzIntersectorResult &data);

private:

    friend class gzIntersectorAction;

    gzVec3                              m_startPos;
    gzVec4                              m_direction;

    gzBool                              m_hasStartPosition;
    gzBool                              m_hasDirection;

    gzIntersectQuery                    m_queryType;

    gzDynamicArray<gzIntersectorResult> m_results;

    gzRefPointer<gzContext>             m_context;

    gzIntersectorAction                 m_action;

    static gzULong                      s_contextTID;

    static gzRefPointer<gzContext>      s_context;

};

// Utilities ----------------------

GZ_GRAPH_EXPORT gzVoid gzGetMouseXYIntersector(gzVec3 &startPosition,gzVec3 &direction,const gzCamera *camera,const gzLong mouse_x,const gzLong mouse_y, const gzULongXY & winSize);


#endif

---