SoNode.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 : Nick Thompson (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-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_NODE_
#define  _SO_NODE_
 
#include <Inventor/fields/SoFieldContainer.h>
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/SoLists.h>
#include <Inventor/SbString.h>
#include <Inventor/SoType.h>
#include <Inventor/sensors/SoDataSensor.h>
#include <Inventor/STL/vector>
#include <Inventor/SbPImpl.h>
#include <bitset>
 
#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable:4251)
#endif
 
class SoNodeList;
class SoAction;
class SoCallbackAction;
class SoChildList;
class SoFieldData;
class SoGLRenderAction;
class SoGetBoundingBoxAction;
class SoGetMatrixAction;
class SoHandleEventAction;
class SoInput;
class SoOutput;
class SoPickAction;
class SoRayPickAction;
class SoSearchAction;
class SoWriteAction;
class SbProjectionCoordinates;
class SoGetPrimitiveCountAction;
class SoComputeRenderUnitIDAction;
class SoDistributeAction;
class SoState;

namespace inventor
{
namespace impl
{
class SoCachedGroupImpl;
}
namespace node
{
class SoConstNode;
}
}
 
SO_PIMPL_BASE_PUBLIC_DECLARATION(SoNode)
 

//
//  Class: SoNode
//
//  Base SoNode class (abstract).
//
 
 

class  SoNode : public SoFieldContainer {
 
  SO_NODE_ABSTRACT_HEADER(SoNode);
  SO_PIMPL_BASE_PUBLIC_HEADER(SoNode)
 
 public:

  inline virtual void setOverride(const SbBool state);

  inline virtual SbBool isOverride() const;

  virtual SoNode *    copy(SbBool copyConnections = FALSE) const;

  virtual SbBool      affectsState() const;

  static SoNode *     getByName(const SbName &name);

  static int          getByName(const SbName &name, SoNodeList &list);
 
  virtual void        touch();
 
private:

  inline virtual SoNode* getAlternateRep(SoAction* action);

  inline virtual SbBool isBoundingBoxIgnoring() const;
 
  // This method performs the "typical" operation of a node for any
  // action. The default implementation does nothing.
  virtual void        doAction(SoAction *action);
 
  // These virtual functions implement all of the actions for nodes,
  // Most of the default implementations do nothing.
  virtual void        GLRender(SoGLRenderAction *action);
  virtual void        callback(SoCallbackAction *action);
  virtual void        getBoundingBox(SoGetBoundingBoxAction *action);
  virtual void        getMatrix(SoGetMatrixAction *action);
  virtual void        handleEvent(SoHandleEventAction *action);
  virtual void        pick(SoPickAction *action);
  virtual void        rayPick(SoRayPickAction *action);
  virtual void        search(SoSearchAction *action);
  virtual void        write(SoWriteAction *action);
  virtual void        getPrimitiveCount(SoGetPrimitiveCountAction *action);
  virtual void        distribute(SoDistributeAction *action);
 
  // These methods make render traversal faster by implementing
  // different rendering paths corresponding to different action
  // path codes.  The SoNode methods just call GLRender.
  virtual void        GLRenderBelowPath(SoGLRenderAction *action);
  virtual void        GLRenderInPath(SoGLRenderAction *action);
  virtual void        GLRenderOffPath(SoGLRenderAction *action);
 
  // These virtual functions are called when a node gains or loses
  // status as "grabber" of events (see HandleEventAction::setGrabber()).
  // The default methods do nothing.
  virtual void        grabEventsSetup();
  virtual void        grabEventsCleanup();
 
  // 
  // This virtual function is called when ScaleViz want to now 
  // if the parent separator must be traversed or not in compositing mode.
  //
  // By default such decision is taken by the Separator iteself through the 
  // renderUnitID field and then returned value is SO_RENDERUNITID_INHERIT.
  //
  // For some class of nodes we want to force a specific values.
  //
  // example :
  //   - SoTransparency node in Depth Compositing on OIRU side return SO_RENDERUNITID_ALL
  //   to force all transparent node below the separator to be rendered on all OIRU.
  //
  virtual int32_t     getRenderUnitID() const;
 
 private:
 
  // Creates and returns an exact copy of the node and returns the
  // dictionary of original and new nodes. This method is used when
  // creating the PROTOInstances on the fly.
  SoNode *            copyForPROTO(SbBool copyConnections = FALSE) const;
  enum Stage {
    FIRST_INSTANCE,         // First real instance being constructed
    PROTO_INSTANCE,         // Prototype instance being constructed
    OTHER_INSTANCE          // Subsequent instance being constructed
  };
 
  // Initializes base node class
  static void         initClass();
  static void         exitClass();
 
  // Initialize ALL Inventor node classes
  static void         initClasses();
  static void         exitClasses();
 
  // Initiates notification from an instance.
  virtual void        startNotify();
 
  // Propagates modification notification through an instance.
  virtual void        notify(SoNotList *list);
 
  // Returns the unique id for a node
  uint64_t getNodeId() const { return m_uniqueId; }
 
  // Returns the next available unique id
  static uint64_t getNextNodeId();
 
  // Returns pointer to children, or NULL if none
  virtual SoChildList *getChildren() const;
  virtual bool isSynchronizingContentOnly() { return FALSE; }
  virtual SoChildList *internalGetChildren() const;
 
  virtual void internalRemoveChild(int);
  virtual void internalRemoveChild(SoNode *);
  virtual void internalRemoveAllChildren();
  virtual void internalAddChild(SoNode *);
  virtual int  internalFindChild(const SoNode *) const;
  virtual void internalInsertChild(SoNode *, int);
  virtual SoNode *internalGetChild( int ) const;
  virtual void internalReplaceChild(int, SoNode *);
  virtual void internalReplaceChild(SoNode *, SoNode *);
  virtual int internalGetNumChildren();
 
  // Get details of change (only valid during notification)
  SoNode* getChangedChild() const;
  int getChangedIndex() const;
  SoDataSensor::ChangeType getChangeType() const;
 
  // Writes instance to SoOutput. (Used for either stage of writing.)
  virtual void        writeInstance(SoOutput *out);
 
  // Returns the index of this node in the action/method table,
  // given its type.
  static int          getActionMethodIndex(SoType t);
 
  // Recursively adds this node and all nodes under it to the copy
  // dictionary. Returns the copy of this node.
  virtual SoNode *    addToCopyDict() const;
 
  // Copies the contents of the given node into this instance. The
  // default implementation copies just field values and the name.
  virtual void        copyContents(const SoFieldContainer *fromFC,
                                   SbBool copyConnections);
 
  // Copies an instance that is encountered through a field connection
  virtual SoFieldContainer *  copyThroughConnection() const;
 
  // Get the curent node alternate representation
  // Cache the alternate rep if requested.
  SoNode* getCachedAlternateRep(SoAction* action, SbBool doCache = FALSE);

  virtual bool affectsPath() const;
 
  // added to manage global node operations for shapes
  virtual void        GLRenderP(SoGLRenderAction *action);
 
 private:
 
  static void setNextActionMethodIndex(int index);
  static int  getNextActionMethodIndex();
  static void incNextActionMethodIndex();
 
  // Constructor, destructor
  SoNode();
  virtual ~SoNode();
 
 private:
  // Unique id for this node.
  uint64_t m_uniqueId;
 
  // Next index into the action method table
  static int         nextActionMethodIndex;
 
  // These static methods are registered with the database - they
  // simply call the appropriate virtual function
  static void callbackS(SoAction *, SoNode *);
  static void GLRenderS(SoAction *, SoNode *);
  static void getBoundingBoxS(SoAction *, SoNode *);
  static void getMatrixS(SoAction *, SoNode *);
  static void handleEventS(SoAction *, SoNode *);
  static void pickS(SoAction *, SoNode *);
  static void rayPickS(SoAction *, SoNode *);
  static void searchS(SoAction *, SoNode *);
  static void writeS(SoAction *, SoNode *);
  static void getPrimitiveCountS(SoAction *, SoNode *);
 
  static void distributeS(SoAction *, SoNode *);
 
  void commonConstructor();
  
  // method to provide forward traversal
  template < class SPEC_ACTION >
  static void traverseS(SoAction *action, SoNode *node);
  // helper to get node to traverse internally
  SoNode* getNodeToTraverse(SoAction* action, bool force = false);
 
  SoNode* m_cachedAlternateRep;
 
 private:
 
  //---------------------------------------------
 
  SbProjectionCoordinates *getProjectionCoordinates(){return m_projCoords;}
 
  void setProjectionCoordinates(SbProjectionCoordinates *projCoords){
    m_projCoords = projCoords;
  }
 
  //Projections
 private:
  SbProjectionCoordinates *m_projCoords;
 
 private:
 
  // hold envvar OIV_CATCH_GLERROR for debugging purpose
  static bool s_catchGLError;
 
  // TO BE DELETED AS SOON AS REWORK OF THESE CLASSES IS DONE
  friend class SoTraversalPassImpl;
  friend class SoLdmValuationAction;
  friend class SoPath;
  friend class SoLightPath;
  friend class SoAction;  
  friend class StringConcatCallback;
  friend class SoChildList;
  friend class SoCacheElement;
  friend class inventor::impl::SoCachedGroupImpl;
  friend class inventor::node::SoConstNode;
  friend class SoCallbackAction;
};
 
SoNode* 
SoNode::getAlternateRep(SoAction*)
{
  return this;
}
 
SbBool 
SoNode::isBoundingBoxIgnoring() const
{
  return FALSE;
}
 
void 
SoNode::setOverride(const SbBool)
{
#if defined(_DEBUG)
  SoDebugError::postWarning("SoNode::setOverride","not reimplemented and supported for this inherited node");
#endif
}
 
SbBool
SoNode::isOverride() const
{
  return FALSE;
}
 
#ifdef _WIN32
#pragma warning(pop)
#endif
 
#endif /* _SO_NODE_ */