SoModelMatrixElement.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Paul S. Strauss (MMM yyyy)
** Modified by : Gavin Bell (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_MODEL_MATRIX_ELEMENT
#define  _SO_MODEL_MATRIX_ELEMENT
 
#include <Inventor/SbLinear.h>
#include <Inventor/elements/SoAccumulatedElement.h>

 
SoEXTENDER_Documented class  SoModelMatrixElement : public SoAccumulatedElement {
 
  SO_ELEMENT_HEADER(SoModelMatrixElement);
 
 public:

  virtual void        push(SoState *state);

  static void         makeIdentity(SoState *state, SoNode *node);

  static void         set(SoState *state, SoNode *node,
                          const SbMatrix &matrix, SbBool sendToGL = TRUE);

  static void         mult(SoState *state, SoNode *node,
                           const SbMatrix &matrix);

  static void         translateBy(SoState *state, SoNode *node,
                                  const SbVec3f &translation);
  static void         rotateBy(SoState *state, SoNode *node,
                               const SbRotation &rotation);
  static void         scaleBy(SoState *state, SoNode *node,
                              const SbVec3f &scaleFactor);

  static SbMatrix     pushMatrix(SoState *state);
  static void         popMatrix(SoState *state, const SbMatrix &m);

  static void         setCullMatrix(SoState *state, SoNode *node,
                                    const SbMatrix &matrix);

  static const SbMatrix &     getCombinedCullMatrix(SoState *state);

  static const SbMatrix &     get(SoState *state);

  static const SbMatrix &     get(SoState *state, SbBool &isIdent);

  virtual void        print(FILE *fp) const;
 
private:

  virtual void init(SoState *state);

  virtual SbBool matches(const SoElement* elt) const;

  virtual SoElement* copyMatchInfo() const;
 
 private:
  // Initializes the SoModelMatrixElement class
  static void         initClass();
  static void         exitClass();
  const SbMatrix&     getModelMatrix() const { return modelMatrix; }
  SbBool              isIdent() const { return flags.isModelIdentity; }

  static const SbMatrix& getCullMatrix(SoState* state);

  const SbMatrix& getCullMatrix();

  static void pushForwardMatrix(SoState *state, SbMatrix& model, SbMatrix& ftmodel);

  static void popForwardMatrix(SoState *state, const SbMatrix &m, const SbMatrix& f);

  static const SbMatrix& getForwardTraversalMatrix(SoState *state);

  static const SbMatrix& getPreForwardTraversalMatrix(SoState *state);

  static void resetForwardTraversalMatrix(SoState *state);
 
 private:
  // Sets the matrix in an instance to identity
  virtual void        makeEltIdentity();
 
  // Sets the matrix in an instance to given matrix
  virtual void        setElt(const SbMatrix &matrix, SbBool sendToGL = TRUE);
 
  // Multiplies into the matrix in an instance
  virtual void        multElt(const SbMatrix &matrix);
 
  // Each of these performs the appropriate operation on the matrix
  // in an instance
  virtual void        translateEltBy(const SbVec3f &translation);
  virtual void        rotateEltBy(const SbRotation &translation);
  virtual void        scaleEltBy(const SbVec3f &scaleFactor);
 
  // virtual methods for push/pop so GL element can Do The Right Thing:
  virtual SbMatrix    pushMatrixElt();
  virtual void        popMatrixElt(const SbMatrix &m);
 
  // same as previous but taking into account forward traversal transformation
 
  virtual void        pushForwardMatrixElt(SbMatrix& m, SbMatrix& f);
 
  virtual void        popForwardMatrixElt(const SbMatrix &m, const SbMatrix& f);
 
  virtual ~SoModelMatrixElement();
 
  SbMatrix            modelMatrix;
 private:
  SbMatrix            cullMatrix;
  SbMatrix            modelCullMatrix;
  SbMatrix            forwardTraversalMatrix; // transformation inside a foward traversal
  SbMatrix            preForwardTraversalMatrix;     // transformation until first foward traversal
  struct Flags {
    unsigned int    isModelIdentity : 1;
    unsigned int    haveCullMatrix  : 1; // TRUE if cullMatrix set
    unsigned int    haveModelCull   : 1; // TRUE if model*cull computed
  };
  Flags flags;
 
  friend class SoLocalBBoxMatrixElement;
};
 
#endif /* _SO_MODEL_MATRIX_ELEMENT */