gzText.h

Go to the documentation of this file.

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

#include "gzNode.h"
#include "gzFont.h"

// Common 2D text start positions
const gzVec3 GZ_TEXT_UPPER_LEFT_POS=gzVec3((gzReal)-1,(gzReal)1,(gzReal)0);
const gzVec3 GZ_TEXT_CENTER_POS=gzVec3((gzReal)0,(gzReal)0,(gzReal)0);

//******************************************************************************
// Class    : gzText
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  001016  Created 
//                                  
//******************************************************************************
class gzText : public gzNode
{
public:
    GZ_GRAPH_EXPORT gzText(const gzString &name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzText(){};

    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;
    GZ_GRAPH_EXPORT virtual gzVoid  setCopyMode(gzCopyMode mode);

    // ---------- text commands -----------------------------------------

    GZ_GRAPH_EXPORT gzVoid setFont(gzFont *font);

    GZ_GRAPH_EXPORT gzVoid useOverlay(gzBool on);

    GZ_GRAPH_EXPORT gzVoid use2DPosition(gzBool on);

    GZ_GRAPH_EXPORT gzVoid set2DPosition( gzShort x_off_pixels=0, gzShort y_off_pixels=0,const gzVec3 &startPosition=GZ_TEXT_UPPER_LEFT_POS);

    GZ_GRAPH_EXPORT gzVoid setText(const gzString &text);

    GZ_GRAPH_EXPORT gzVoid setText(gzWideChar *text,gzULong len);

    GZ_GRAPH_EXPORT gzVoid clear();

    GZ_GRAPH_EXPORT gzVoid format( const gzString &format, ARG_DECL_LIST );

    GZ_GRAPH_EXPORT gzVoid setColor(const gzVec4 &color);

    GZ_GRAPH_EXPORT gzVoid setMaskColor(const gzVec4 &maskColor);

    GZ_GRAPH_EXPORT gzVoid useMaskColor(gzBool on);

    GZ_GRAPH_EXPORT gzVoid useScreenFixFont(gzBool on=TRUE);

    GZ_GRAPH_EXPORT gzVoid useTransparentBackground(gzBool on=TRUE);

    GZ_GRAPH_EXPORT gzVoid scrollText(const gzString &text, gzBool down=FALSE);

    GZ_GRAPH_EXPORT gzVoid renderText(gzContext *context, gzVec3 rasterpos);

    // ---------- overall orientation etc.. ------------------------------

    GZ_GRAPH_EXPORT gzVoid  setScale(const gzVec3 &scale);
    GZ_GRAPH_EXPORT gzVoid  setScale(gzFloat scale);

    GZ_GRAPH_EXPORT gzVoid  setHPR(const gzVec3 &hpr);
    GZ_GRAPH_EXPORT gzVoid  setHPR(gzFloat heading,gzFloat pitch,gzFloat roll);

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

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

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

    // ---------- Debug function ----------------------------------------
    GZ_GRAPH_EXPORT virtual gzVoid  debugOutput(gzString base , gzString anchor , gzDebugFlags features);

    // ---------- Properties -------------------------------------------
    
    GZ_PROPERTY_EXPORT(gzReal,              DeltaX,         GZ_GRAPH_EXPORT);   
    GZ_PROPERTY_EXPORT(gzReal,              DeltaY,         GZ_GRAPH_EXPORT);   

    GZ_PROPERTY_EXPORT(gzArray<gzReal>,     TSpanX,         GZ_GRAPH_EXPORT);   
    GZ_PROPERTY_EXPORT(gzArray<gzReal>,     TSpanY,         GZ_GRAPH_EXPORT);   

protected:

    gzBool                  m_useOverlay:1;

    gzBool                  m_use2DPosition:1;

    gzBool                  m_useMaskColor:1;

    gzBool                  m_useScreenFixFont:1;

    gzBool                  m_useTranspBack:1;

    gzRefPointer<gzFont>    m_font;

    gzVec4                  m_color;

    gzVec4                  m_maskColor;

    gzVec3                  m_2DPosition;

    gzShort                 m_x_off_pixels;

    gzShort                 m_y_off_pixels;

    gzVec3                  m_scale;

    gzVec3                  m_hpr;

    gzArray<gzWideChar>     m_text;

};

// Declare smart pointer type
GZ_DECLARE_REFPTR(gzText);

#endif

---