MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/elements/SoGLLazyElement.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */


/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.2 $
 |
 |   Description:
 |      This file defines the SoGLLazyElement class.
 |
 |   Author(s)          : Alan Norton,  Gavin Bell 
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */

#ifndef  _SO_GL_LAZY_ELEMENT
#define  _SO_GL_LAZY_ELEMENT

#include <Inventor/elements/SoLazyElement.h>
#include <Inventor/actions/SoGLRenderAction.h>
class SoGLRenderCache;
class SoVBO;


SoEXTENDER class INVENTOR_API SoGLLazyElement : public SoLazyElement {

    SO_ELEMENT_HEADER(SoGLLazyElement);

  public:
    virtual void        init(SoState *state);

    virtual void        push(SoState *state);
    virtual void        pop(SoState *state, const SoElement *prevTopElement);

    static void         sendAllMaterial(SoState *state)
        {SoGLLazyElement *le = getInstance(state);
        if ((le->invalidBits)||(state->isCacheOpen()))  
            le->reallySend(state, ALL_MASK);}
            
    static void         sendNoMaterial(SoState *state)
        {SoGLLazyElement *le = getInstance(state);
        if ((NO_COLOR_MASK & le->invalidBits)||(state->isCacheOpen()))  
            le->reallySend(state, NO_COLOR_MASK);}
            
    static void         sendOnlyDiffuseColor(SoState *state)
        {SoGLLazyElement *le = getInstance(state);
        if ((DIFFUSE_ONLY_MASK & le->invalidBits)||(state->isCacheOpen()))  
            le->reallySend(state, DIFFUSE_ONLY_MASK);}
            
    void sendDiffuseByIndex(int index) const; 
    
    void reset(SoState* state,  uint32_t bitmask) const;
    
    static SbBool       isColorIndex(SoState *state)
        {return(getInstance(state)->colorIndex);}
        
    static  SoGLLazyElement * getInstance(const SoState *state)
        {return (SoGLLazyElement *) 
        (state->getConstElement(classStackIndex));}
                                
  SoINTERNAL public:
    static void         initClass();
    
    void                send(const SoState *state, uint32_t mask) const
        {if ((mask & invalidBits)||(state->isCacheOpen()))  
            ((SoGLLazyElement*)(this))->reallySend(state, mask);} 
            
    virtual SbBool      matches(const SoElement *) const
        {return FALSE;}
    virtual SoElement   *copyMatchInfo() const 
        {return NULL;}
        
    SbBool lazyMatches(uint32_t checkGLFlag, uint32_t checkIVFlag,
        const SoGLLazyElement* eltInState){
        if (checkGLFlag || checkIVFlag ||
            (ivState.transpType != eltInState->ivState.transpType))
            return (fullLazyMatches (checkGLFlag, checkIVFlag, eltInState));
        else return(TRUE);
        } 

   typedef struct {
        uint32_t        GLDiffuseNodeId;
        uint32_t        GLTranspNodeId;
        float           GLAmbient[4];
        float           GLEmissive[4];
        float           GLSpecular[4];
        float           GLShininess;
        SbBool          GLColorMaterial;        
        int32_t         GLLightModel;
        SbBool          GLblending;
        int32_t         GLStippleNum;
    } GLLazyState; 
    
    SoGLLazyElement* copyLazyMatchInfo(SoState* state);

    void getCopyGL(SoGLLazyElement* cacheLazyElement, 
        SoGLLazyElement::GLLazyState& cacheGLState);

    void copyBackGL(SoGLLazyElement* cacheLazyElement, 
        SoGLLazyElement::GLLazyState& cacheGLState) 
        { if (cacheLazyElement->GLSendBits) 
            reallyCopyBackGL(cacheLazyElement->GLSendBits, cacheGLState);}
              
    void sendVPPacked(SoState* state, const unsigned char* pcolor);
          
    virtual ~SoGLLazyElement();
    
    void mergeCacheInfo(SoGLRenderCache* childCache, SoGLRenderCache* 
        parentCache, uint32_t doSendFlag, uint32_t checkIVFlag, 
        uint32_t checkGLFlag);
  
    void updateColorVBO(SoState* state, SoVBO* vbo);

  private:         
    void copyGLValues(uint32_t bitmask, SoGLLazyElement* cacheLazyElement);
    void copyIVValues(uint32_t bitmask, SoGLLazyElement* cacheLazyElement);
    
    void reallySend(const SoState *state, uint32_t bitmask);
    
    SbBool fullLazyMatches(uint32_t checkGLFlag, uint32_t checkIVFlag,
        const SoGLLazyElement* eltInState);

    void packColors(SoColorPacker *cPacker);
        
    virtual void        setDiffuseElt(SoNode *node, int32_t numColors, 
                            const SbColor *colors,  SoColorPacker *cPacker);

    virtual void        setTranspElt(SoNode *node,  int32_t numTrans,  
                            const float *trans, SoColorPacker *cPacker);
                            
    virtual void        setTranspTypeElt(int32_t type); 
    virtual void        setPackedElt( SoNode *node, 
                            int32_t numColors,  const uint32_t *packedColors);

    virtual void        setColorIndexElt( SoNode*, int32_t numIndices, 
                            const int32_t *indices);
                                                         
    virtual void        setAmbientElt(const SbColor* color);
    virtual void        setEmissiveElt( const SbColor* color);
    virtual void        setSpecularElt(const SbColor* color);
    virtual void        setShininessElt( float color);
    virtual void        setColorMaterialElt( SbBool value);
    virtual void        setBlendingElt( SbBool value);
    virtual void        setLightModelElt(SoState *, int32_t model);
    virtual void        setMaterialElt(SoNode *, uint32_t bitmask, 
        SoColorPacker *cPacker, const SoMFColor&, 
        const SoMFFloat&, const SoMFColor&,     
        const SoMFColor&, const SoMFColor&, const SoMFFloat&);

    virtual void        registerRedundantSet(SoState *, uint32_t bitmask);
    virtual void        registerGetDependence(SoState *, uint32_t bitmask);

    void reallyCopyBackGL(uint32_t bitmask, SoGLLazyElement::GLLazyState&  );
    
    SoGLLazyElement::GLLazyState glState;
  
    uint32_t GLSendBits;
    
    SbBool colorIndex;

    static u_char       patterns[64+1][32 * 4];

    static SbBool       patternsCreated;

    static SbBool       patternListDefined[64+1];

    static int          patternListBase;

    static int          patternListContext;

    SbBool              cacheOpen;

    void                sendStipple(const SoState *state, int transpIndex);
    
    static void         createPatterns();  
};

#endif /* _SO_GL_LAZY_ELEMENT */