gzBillboard.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzBillboard.h
// Module       : 
// Description  : Class definition of the gzBillboard 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  990511  Created file    
//
//******************************************************************************
#ifndef __GZ_BILLBOARD_H__
#define __GZ_BILLBOARD_H__

#include "gzTransform.h"

typedef enum {  GZ_BILLBOARD_AXIS ,                 
                GZ_BILLBOARD_POINT_AXIS ,           
                GZ_BILLBOARD_POINT_CAMERA_UP ,      
                GZ_BILLBOARD_POINT_CAMERA_ORTHO     
} gzBillboardType;

//******************************************************************************
// Class    : gzBillboard
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  990511  Created 
//                                  
//******************************************************************************
class gzBillboard : public gzTransform
{
public:

    GZ_GRAPH_EXPORT gzBillboard(const gzString &name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzBillboard(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

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


    GZ_GRAPH_EXPORT virtual gzVoid updateNode();

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

    // ---------- billboard commands -------------------------------------

    GZ_GRAPH_EXPORT gzVoid setAxis(gzVec3 axis);


    GZ_GRAPH_EXPORT gzVoid setType(gzBillboardType type);

    //Aligns billboard orthogonal to the viewer center z axis.
    GZ_GRAPH_EXPORT gzVoid usePlanarBillboard(gzBool on);

    // ---------- Action Interface --------------------------------------

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

protected:

    GZ_GRAPH_EXPORT gzVoid calculateBillboardTransform(gzContext *context,gzBool force=FALSE);

private:

    gzBillboardType     m_type:3;
    gzBool              m_usePlanarBillboard:1;

    gzVec3              m_upAxis;
    gzVec3              m_lastCalc_e;

};

#endif

---