Source/System/NodeCores/Groups/Misc/OSGBillboard.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 by the OpenSG Forum                   *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGBILLBOARD_H_
  40 #define _OSGBILLBOARD_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGBillboardBase.h"
  46 #include "OSGAction.h"
  47
  48 OSG_BEGIN_NAMESPACE
  49
  50 /*! \brief *put brief class description here*
  51     \ingroup GrpGroupMiscObj
  52     \ingroup GrpLibOSGGroup
  53     \includebasedoc
  54  */
  55
  56 class OSG_GROUP_DLLMAPPING Billboard : public BillboardBase
  57 {
  58     /*==========================  PUBLIC  =================================*/
  59
  60   public:
  61
  62     /*---------------------------------------------------------------------*/
  63     /*! \name                      Sync                                    */
  64     /*! \{                                                                 */
  65
  66     virtual void changed(ConstFieldMaskArg whichField,
  67                          UInt32            origin,
  68                          BitVector         detail);
  69
  70     /*! \}                                                                 */
  71     /*---------------------------------------------------------------------*/
  72     /*! \name               calc the model matrix                          */
  73     /*! \{                                                                 */
  74
  75     void calcMatrix(const Matrix         &camToWorld,
  76                     const Matrix         &mToWorld,
  77                           Matrix         &mResult);
  78
  79     /*! \}                                                                 */
  80     /*---------------------------------------------------------------------*/
  81     /*! \name                   Transformation                             */
  82     /*! \{                                                                 */
  83
  84     virtual void accumulateMatrix(Matrix &result);
  85
  86     /*! \}                                                                 */
  87     /*---------------------------------------------------------------------*/
  88     /*! \name                     Output                                   */
  89     /*! \{                                                                 */
  90
  91     virtual void dump(      UInt32     uiIndent = 0,
  92                       const BitVector  bvFlags  = 0) const;
  93
  94     /*! \}                                                                 */
  95     /*=========================  PROTECTED  ===============================*/
  96
  97   protected:
  98
  99     // Variables should all be in BillboardBase.
 100
 101     Matrix _camTransform;
 102
 103     /*---------------------------------------------------------------------*/
 104     /*! \name                  Constructors                                */
 105     /*! \{                                                                 */
 106
 107     Billboard(void);
 108     Billboard(const Billboard &source);
 109
 110     /*! \}                                                                 */
 111     /*---------------------------------------------------------------------*/
 112     /*! \name                   Destructors                                */
 113     /*! \{                                                                 */
 114
 115     virtual ~Billboard(void);
 116
 117     /*! \}                                                                 */
 118     /*---------------------------------------------------------------------*/
 119     /*! \name                      Volume                                  */
 120     /*! \{                                                                 */
 121
 122     virtual void adjustVolume    (Volume &volume);
 123
 124     /*! \}                                                                 */
 125     /*---------------------------------------------------------------------*/
 126     /*! \name              Draw & Intersect & Render                       */
 127     /*! \{                                                                 */
 128
 129     Action::ResultE intersectEnter(Action *action);
 130     Action::ResultE intersectLeave(Action *action);
 131
 132     Action::ResultE renderEnter   (Action *action);
 133     Action::ResultE renderLeave   (Action *action);
 134
 135     /*! \}                                                                 */
 136     /*==========================  PRIVATE  ================================*/
 137
 138   private:
 139
 140     typedef BillboardBase Inherited;
 141
 142     friend class FieldContainer;
 143     friend class BillboardBase;
 144
 145     static void initMethod(InitPhase ePhase);
 146
 147     // prohibit default functions (move to 'public' if you need one)
 148     void operator =(const Billboard &source);
 149 };
 150
 151 typedef Billboard *BillboardP;
 152
 153 OSG_END_NAMESPACE
 154
 155 #include "OSGBillboardBase.inl"
 156 #include "OSGBillboard.inl"
 157
 158 #endif /* _OSGBILLBOARD_H_ */
 159