gzGeometryUtils.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzGeometryUtils.h
// Module       : 
// Description  : Class definition of the geometry utility classes
// 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  021213  Created file    
//
//******************************************************************************
#ifndef __GZ_GEOMETRY_UTILS_H__
#define __GZ_GEOMETRY_UTILS_H__

#include "gzGeometry.h"
#include "gzText.h"
#include "gzIntersector.h"
#include "gzShadowVolume.h"
#include "gzRenderBase.h"

//******************************************************************************
// Class    : gzGeometryAxis
//                                  
// Purpose  : Coordinate Axis used in development to see local coordinates
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  981122  Created 
//                                  
//******************************************************************************
class gzGeometryAxis : public gzGeometry
{
public:
    GZ_GRAPH_EXPORT gzGeometryAxis(gzReal size , gzReal step , const gzVec4 &color=gzVec4(0.0,0.0,0.0,1.0),const gzString & name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzGeometryAxis(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    // ---- util functions -------

    GZ_PROPERTY_EXPORT_(    gzReal  ,   Size    ,   GZ_GRAPH_EXPORT);
    GZ_PROPERTY_EXPORT_(    gzReal  ,   Step    ,   GZ_GRAPH_EXPORT);

private:

    gzVoid createGeometryAxis();
};

//******************************************************************************
// Class    : gzGeometrySphere
//                                  
// Purpose  : A Simple Sphere
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  011011  Created 
//                                  
//******************************************************************************
class gzGeometrySphere : public gzGeometry
{
public:
    GZ_GRAPH_EXPORT gzGeometrySphere(gzReal radius , gzInt sections=30 , const gzVec4 &color=gzVec4(1.0,1.0,1.0,1.0) , const gzString & name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzGeometrySphere(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

};

typedef  gzReal     (*gzEvalFunc_Tube_Radius)       (gzReal zero_to_one, gzReal angle);
typedef  gzRealXY   (*gzEvalFunc_Tube_Displacement) (gzReal zero_to_one);

//********************** Some sample evaluation functions **********************

// --- Radius methods ----

GZ_GRAPH_EXPORT gzReal GZ_TUBE_CONE(gzReal zero_to_one, gzReal angle);

//******************************************************************************
// Class    : gzGeometryTube
//                                  
// Purpose  : A Rather Simple Tube
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  030315  Created 
//                                  
//******************************************************************************
class gzGeometryTube : public gzGeometry
{
public:

    GZ_GRAPH_EXPORT gzGeometryTube(     gzFloat length=10,
                                        gzFloat width=1,
                                        gzULong lengthSamples=10,
                                        gzULong widthSamples=10,
                                        gzEvalFunc_Tube_Radius          evalRadiusFunc=NULL,
                                        gzEvalFunc_Tube_Displacement    evalDisplacementFunc=NULL,
                                        gzFloat texture_x_scale=1,
                                        gzFloat texture_y_scale=1,
                                        const gzVec4 &color=gzVec4(1.0,1.0,1.0,1.0) , 
                                        const gzString & name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzGeometryTube(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

};


enum gzViewPlaneAlign
{
    GZ_VIEWPLANE_ALIGN_UPPER_LEFT,
    GZ_VIEWPLANE_ALIGN_UPPER_RIGHT,
    GZ_VIEWPLANE_ALIGN_BOTTOM_LEFT,
    GZ_VIEWPLANE_ALIGN_BOTTOM_RIGHT,
    GZ_VIEWPLANE_ALIGN_UPPER_CENTER,
    GZ_VIEWPLANE_ALIGN_BOTTOM_CENTER,
    GZ_VIEWPLANE_ALIGN_LEFT_CENTER,
    GZ_VIEWPLANE_ALIGN_RIGHT_CENTER
};

//******************************************************************************
// Class    : gzViewPlane
//                                  
// Purpose  : Projects a HUD plane covering full screen at user defined distance
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  020204  Created 
//                                  
//******************************************************************************
class gzViewPlane : public gzBaseGeometry
{
public:
    GZ_GRAPH_EXPORT gzViewPlane(const gzReal &distance=-1,const gzVec4 &color=gzVec4(0.0,0.0,0.0,1.0),const gzString & name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzViewPlane(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);

    // ---------- Common graph functions --------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid updateNode();

    // ---------- No cloning of base - pure virtual ---------------------

    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    // ---------- ViewPlane methods -------------------------------------

    GZ_GRAPH_EXPORT gzVoid  setCoordinates(const gzVec2 & bottomLeftCoordinate, const gzVec2 & upperRightCoordinate);

    GZ_GRAPH_EXPORT gzVoid  setTexCoordinates(const gzVec2 & bottomLeftTexCoordinate, const gzVec2 & upperRightTexCoordinate);

    GZ_GRAPH_EXPORT gzVoid  setColor(const gzVec4 &color);


    GZ_GRAPH_EXPORT gzVoid  usePixelPosition(gzBool on);    // Use pixels and alignment. pos dep on alignment

    GZ_GRAPH_EXPORT gzVoid  setAlignment(gzViewPlaneAlign alignment);

    // ---------- Properties -------------------------------------------

    GZ_PROPERTY_EXPORT( gzBool          ,   UseIntersection         , GZ_GRAPH_EXPORT);
    
private:

    gzReal  m_distance;

    gzVec4  m_color;

    gzVec2  m_bottomLeftCoordinate;     // default (-1,-1)  x-> right y-> up from bottom left

    gzVec2  m_upperRightCoordinate;     // default (0,0)

    gzVec2  m_bottomLeftTexCoordinate;

    gzVec2  m_upperRightTexCoordinate;

    gzViewPlaneAlign        m_align;    // Default upper left corner. Only for pixel positions

    gzBool  m_usePixelPosition;             // Default FALSE


};

// Declare smart pointer type
GZ_DECLARE_REFPTR(gzViewPlane);

enum gzAngleUnits
{
    GZ_ANGLE_UNIT_DEGREES,
    GZ_ANGLE_UNIT_RADIANS,
    GZ_ANGLE_UNIT_MILS
};

//******************************************************************************
// Class    : gzLineOfSight
//                                  
// Purpose  : Calculates and draws a LOS vector from start to stop with 
//            measured values.
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  021204  Created 
//                                  
//******************************************************************************
class gzLineOfSight : public gzBaseGeometry
{
public:
    GZ_GRAPH_EXPORT gzLineOfSight(const gzVec3 & start=gzVec3(0,0,0) , const gzVec3 & stop=gzVec3(0,0,0) , const gzVec4 &color=gzVec4(1.0,1.0,1.0,1.0),const gzString & name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzLineOfSight(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface


    // ---------- Common graph functions --------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid updateNode();

    GZ_GRAPH_EXPORT virtual gzActionStage useActionStage( gzTraverseAction *actionclass , gzContext *context);

    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);

    // ---------- No cloning of base - pure virtual ---------------------

    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    // ---------- The control API ---------------------------------------

    GZ_GRAPH_EXPORT gzVoid  setStartPosition(const gzVec3 & start);

    GZ_GRAPH_EXPORT gzVoid  setStopPosition(const gzVec3 & stop);

    GZ_GRAPH_EXPORT gzVoid  setNodeTree(gzNode *tree);

    // ---------- Properties -------------------------------------------

    GZ_PROPERTY_EXPORT( gzVec3          ,   NorthVector             , GZ_GRAPH_EXPORT);
    GZ_PROPERTY_EXPORT( gzVec3          ,   EastVector              , GZ_GRAPH_EXPORT);
    GZ_PROPERTY_EXPORT( gzBool          ,   ShowBearing             , GZ_GRAPH_EXPORT);
    GZ_PROPERTY_EXPORT( gzAngleUnits    ,   BearingUnits            , GZ_GRAPH_EXPORT);
    GZ_PROPERTY_EXPORT( gzBool          ,   ShowTotalDistance       , GZ_GRAPH_EXPORT);
    GZ_PROPERTY_EXPORT( gzBool          ,   ShowLineOfSightDistance , GZ_GRAPH_EXPORT);



private:

    gzVec4                  m_color;

    gzVec3                  m_start;

    gzVec3                  m_stop;

    gzDouble                m_animationTick;

    gzDouble                m_updateTick;

    gzUShort                m_stipple;

    gzNodePtr               m_nodeTree;

    gzIntersector           m_intersector;

    gzBool                  m_needUpdate;

    gzVec3                  m_hitPoint;

    gzText                  m_text;
};

// Declare smart pointer type
GZ_DECLARE_REFPTR(gzLineOfSight);


//******************************************************************************
// Class    : gzVisualCoverage
//                                  
// Purpose  : Calculates and renders the visual coverage as seen from a certain
//            point. The actual inverse of a shaodw
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  021204  Created 
//                                  
//******************************************************************************
class gzVisualCoverage : public gzShadowRender
{
public:

    GZ_GRAPH_EXPORT gzVisualCoverage(const gzString & name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzVisualCoverage();

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface


    // -- gzVisualCoverage interface -------------------------------------

    GZ_GRAPH_EXPORT gzVoid  setPosition(const gzVec3 &pos);

    GZ_GRAPH_EXPORT gzVoid  setNodeTree(gzNode *tree);

private:

    gzRefPointer<gzNode>            m_nodeTree;

    gzRefPointer<gzLight>           m_light;

    gzRefList<gzShadowGenerator>    m_generators;

};

//******************************************************************************
// Class    : gzVisualCovSample
//                                  
// Purpose  : Calculates and renders the visual coverage as sampled from a certain
//            point. View position dependant.
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  021204  Created 
//                                  
//******************************************************************************
class gzVisualCovSample : public gzBaseGeometry
{
public:

    GZ_GRAPH_EXPORT gzVisualCovSample(gzImageRenderInterface *renderer , gzImage *image , const gzString & name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzVisualCovSample();

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    // ---------- Common graph functions --------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid updateNode();

    GZ_GRAPH_EXPORT virtual gzActionStage useActionStage( gzTraverseAction *actionclass , gzContext *context);

    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);

    // ---------- No cloning of base - pure virtual ---------------------

    GZ_GRAPH_EXPORT virtual gzReference* clone() const;


    // -- gzVisualCovSample interface -------------------------------------

    GZ_GRAPH_EXPORT gzVoid  setPosition(const gzVec3 &pos,const gzDouble &maxRadius=10000);

    GZ_GRAPH_EXPORT gzVoid  lookAt(const gzVec3 &pos);

    GZ_GRAPH_EXPORT gzVoid  setNodeTree(gzNode *tree);

    GZ_GRAPH_EXPORT gzImage *getCoverageImage();

private:

    gzVoid  generateGeometry();

    gzDynamicArray<gzVec3>                  m_geometry;

    gzRefPointer<gzImageRenderInterface>    m_imageRender;

    gzRefPointer<gzImage>                   m_image;

    gzMatrix4                               m_matrix;
};

enum gzSkyBoxLocation
{
    GZ_SKYBOX_EAST  =0,
    GZ_SKYBOX_WEST  =1,
    GZ_SKYBOX_SOUTH =2,
    GZ_SKYBOX_NORTH =3,
    GZ_SKYBOX_GROUND=4,
    GZ_SKYBOX_SKY   =5
};

class gzQuadTexMapping
{
public:

    gzQuadTexMapping(gzVec2 _c1=gzVec2(0,0),gzVec2 _c2=gzVec2(1,0),gzVec2 _c3=gzVec2(1,1),gzVec2 _c4=gzVec2(0,1)):c1(_c1),c2(_c2),c3(_c3),c4(_c4){}

    gzVec2 center()
    {
        return (c1+c2+c3+c4)*0.25;
    }
    
    gzVec2  c1;
    gzVec2  c2;
    gzVec2  c3;
    gzVec2  c4;
};

//******************************************************************************
// Class    : gzSkyBox
//                                  
// Purpose  : Calculates and renders a skybox around the viewer
//            
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  030328  Created 
//                                  
//******************************************************************************
class gzSkyBox : public gzBaseGeometry
{
public:

    GZ_GRAPH_EXPORT gzSkyBox(const gzString & name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzSkyBox();

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    // ---------- Common graph functions --------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid updateNode();

    GZ_GRAPH_EXPORT virtual gzActionStage useActionStage( gzTraverseAction *actionclass , gzContext *context);

    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);

    // ---------- No cloning of base - pure virtual ---------------------

    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    // ---------- Skybox methods ----------------------------------------

    GZ_GRAPH_EXPORT gzVoid      setOrientation(gzReal heading, gzReal pitch , gzReal roll);

    GZ_GRAPH_EXPORT gzVoid      setGroundPoint( gzReal x , gzReal y , gzReal z);

    GZ_GRAPH_EXPORT gzVoid      setStandardHeight(gzReal height);

    GZ_GRAPH_EXPORT gzVoid      setHorizonAngle(gzReal angle);

    GZ_GRAPH_EXPORT gzVoid      useFixedHeight(gzBool on=FALSE);

    GZ_GRAPH_EXPORT gzVoid      setImageSide(gzSkyBoxLocation side, gzImage *image,gzQuadTexMapping mapping=gzQuadTexMapping());

    // --------- Special acess methods for expert users ----------------

    GZ_GRAPH_EXPORT gzState *   getState(gzSkyBoxLocation side);

private:

    gzMatrix4   m_transform;

    gzVec3      m_groundPoint;

    gzReal      m_height_y;

    gzReal      m_horiz_angle;

    gzArray<gzRefPointer<gzState> >     m_texSides;
    gzArray<gzQuadTexMapping>           m_texMapping;

    gzBool      m_useFixedHeight:1;
    gzBool      m_hasDefinedSides:1;
};

// Declare smart pointer type
GZ_DECLARE_REFPTR(gzSkyBox);

//******************************************************************************
// Class    : gzSkyLayer
//                                  
// Purpose  : renders layers of sky data
//            
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  030328  Created 
//                                  
//******************************************************************************
class gzSkyLayer : public gzBaseGeometry
{
public:

    GZ_GRAPH_EXPORT gzSkyLayer(const gzString & name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzSkyLayer();

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    // ---------- Common graph functions --------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid updateNode();

    GZ_GRAPH_EXPORT virtual gzActionStage useActionStage( gzTraverseAction *actionclass , gzContext *context);

    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);

    // ---------- No cloning of base - pure virtual ---------------------

    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    // ---------- Skybox methods ----------------------------------------

    GZ_GRAPH_EXPORT gzVoid  setOrientation(gzReal heading, gzReal pitch , gzReal roll);

    GZ_GRAPH_EXPORT gzVoid  setGroundPoint( gzReal x , gzReal y , gzReal z);

    GZ_GRAPH_EXPORT gzVoid  setStandardHeight(gzReal height);

    GZ_GRAPH_EXPORT gzVoid  setHorizonAngle(gzReal angle);

    GZ_GRAPH_EXPORT gzVoid  setLayerImage(gzImage *image , gzReal width , gzReal length , gzReal heightAboveGround , gzReal northSpeed=0, gzReal eastSpeed=0);

    GZ_GRAPH_EXPORT gzVoid  useFixedHeight(gzBool on=FALSE);

private:

    gzMatrix4   m_transform;

    gzVec3      m_groundPoint;

    gzReal      m_height_y;

    gzReal      m_horiz_angle;

    gzRefPointer<gzState>   m_skyLayer;

    gzReal      m_heightAboveGround;

    gzReal      m_width;

    gzReal      m_length;

    gzReal      m_northSpeed;

    gzReal      m_eastSpeed;

    gzBool      m_useFixedHeight:1;

};

// Declare smart pointer type
GZ_DECLARE_REFPTR(gzSkyLayer);


//******************************************************************************
// Class    : gzIBRIndexSets
//                                  
// Purpose  : IBR index data
//            
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  030714  Created 
//                                  
//******************************************************************************
class gzIBRIndexSets : public gzReference
{
public:

    GZ_GRAPH_EXPORT static gzIBRIndexSets * getIndexSet(gzULong width,gzULong height);

    GZ_GRAPH_EXPORT virtual ~gzIBRIndexSets(){};

private:

    friend class gzIBRGeometry;

    gzIBRIndexSets(gzULong width , gzULong height);

    static gzRefList<gzIBRIndexSets>    s_indexStorage;

    gzULong             m_width;
    gzULong             m_height;

    gzArray<gzULong>    m_index;
    gzArray<gzShortXY>  m_xy;


    gzUInt              m_bufIndexID;

};


//******************************************************************************
// Class    : gzIBRGeometry
//                                  
// Purpose  : IBR geometry
//            
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  030714  Created 
//                                  
//******************************************************************************
class gzIBRGeometry : public gzBaseGeometry
{
public:

    GZ_DECLARE_TYPE_INTERFACE;      // provide RTTI typed interface

    GZ_GRAPH_EXPORT gzIBRGeometry(const gzString & name="gzIBRGeometry");

    GZ_GRAPH_EXPORT virtual ~gzIBRGeometry(){};
    
    // ---------- Clone interface ---------------------------------------

    GZ_GRAPH_EXPORT virtual gzReference* clone() const; // Provide a clone method for factories
    
    // ---------- Action Interface --------------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);
    
    GZ_GRAPH_EXPORT virtual gzVoid postTraverseAction( gzTraverseAction *actionclass , gzContext *context);
    
    GZ_GRAPH_EXPORT virtual gzActionStage useActionStage( gzTraverseAction *actionclass , gzContext *context);
    
    GZ_GRAPH_EXPORT virtual gzVoid updateNode();

    // ---------- IBR Interface ----------------------------------------
    
    GZ_GRAPH_EXPORT gzVoid setSize(gzULong size_x, gzULong size_y);
    
    GZ_GRAPH_EXPORT gzVoid setDepthMap(gzImage *image);
    
    GZ_GRAPH_EXPORT gzVoid setColorMap(gzImage *image);
    
    GZ_GRAPH_EXPORT gzVoid setTransform(const gzMatrix4 &matrix);
    
    GZ_GRAPH_EXPORT gzVoid filterSideGeometry(gzReal stepVal=0.0001);
    
private:

    gzBool isDiscreteJump(gzLong width,gzLong height,gzReal max);
    
    gzFloat getDepth(gzLong width,gzLong height);

    gzULong                                         m_width;

    gzULong                                         m_height;

    gzRefPointer<gzIBRIndexSets>                    m_indexSet;

    gzRefPointer<gzImage>                           m_depthMap;

    gzRefPointer<gzImage>                           m_colorMap;

    gzRefPointer<gzGFXProgram>                      m_program;

    gzMatrix4                                       m_transform;

    gzRefPointer<gzTexture>                         m_texture;  
    
    gzBool                                          m_rebindIndex;

    gzBool                                          m_rebindDepth;

    gzUInt                                          m_bufID;
};

//******************************************************************************
// Geometry calculation utilities
//******************************************************************************

GZ_GRAPH_EXPORT gzBool gzIntersect(const gzVec3 &origin, const gzVec3 &direction, const gzVec3 &v0, const gzVec3 &v1 ,const gzVec3 &v2 , gzVec3 &p);

GZ_GRAPH_EXPORT gzVoid gzUVMap(const gzVec3 &v0, const gzVec3 &v1 ,const gzVec3 &v2 , const gzVec3 &p , gzFloat &u , gzFloat &v);

//******************************************************************************
// Render utilities
//******************************************************************************

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

#endif

---