SoViewingCube.h

/*=================================================================================
 *** 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-2021 BY FEI S.A.S,                    ***
 ***                              BORDEAUX, FRANCE                              ***
 ***                            ALL RIGHTS RESERVED                             ***
 =================================================================================*/
 
#pragma once
 
#include <Inventor/SbPImpl.h>
#include <Inventor/nodes/SoNode.h>
#include <Inventor/fields/SoSFNode.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoSFColor.h>
#include <Inventor/fields/SoSFVec2f.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFFilePathString.h>
 
SO_PIMPL_PUBLIC_DECLARATION( SoViewingCube )
 
 
class  SoViewingCube : public SoNode
{
  SO_NODE_HEADER( SoViewingCube );
  SO_PIMPL_PUBLIC_HEADER( SoViewingCube )
 
public:
  enum PositionInViewport
  {
    TOP_RIGHT,
    TOP_LEFT,
    BOTTOM_RIGHT,
    BOTTOM_LEFT,
  };
 
  enum EdgeStyle
  {
    FLAT,
    ROUND,
    CORNER,
  };
 
  SoSFNode sceneCamera;
 
  SoSFVec2f size;
 
  SoSFEnum position;
 
  SoSFEnum edgeStyle;
 
  SoSFColor selectionColor;
 
 
  SoSFColor faceColor;
 
 
  SoSFColor edgeColor;
 
 
  SoSFColor cornerColor;
 
  SoSFFilePathString facePosX;
 
  SoSFFilePathString faceNegX;
 
  SoSFFilePathString facePosY;
 
  SoSFFilePathString faceNegY;
 
  SoSFFilePathString facePosZ;
 
  SoSFFilePathString faceNegZ;
 
  SoSFFloat edgeSize;
 
  SoSFFloat animationDuration;
 
  SoSFEnum upAxis;
 
  SoSFFloat opacityMin;
 
  SoSFFloat opacityMax;
 
  SoSFNode compass;
 
  SoViewingCube();
 
  virtual SbBool affectsState() const;
 
private:
  // Implement actions
  virtual void GLRender( SoGLRenderAction* action );
  virtual void handleEvent( SoHandleEventAction* ha );
 
private:
  static void initClass();
  static void exitClass();
  virtual void fieldHasChanged(SoField* field);
 
  virtual SoChildList* getChildren() const;
 
private:
  virtual ~SoViewingCube();
 
private:
  
  enum EasingType
  {
    /* bezier cubic curve from points (0, 0), (0.47, 0), (0.745, 0.715), (1, 1) */
    EaseInSine,
    /* bezier cubic curve from points (0, 0), (0.39, 0.575), (0.565, 1), (1, 1) */
    EaseOutSine,
    /* bezier cubic curve from points (0, 0), (0.445, 0.05), (0.55, 0.95), (1, 1) */
    EaseInOutSine,
    /* bezier cubic curve from points (0, 0), (0.55, 0.085), (0.68, 0.53), (1, 1) */
    EaseInQuad,
    /* bezier cubic curve from points (0, 0), (0.25, 0.46), (0.45, 0.94), (1, 1) */
    EaseOutQuad,
    /* bezier cubic curve from points (0, 0), (0.455, 0.03), (0.515, 0.955), (1, 1) */
    EaseInOutQuad,
    /* bezier cubic curve from points (0, 0), (0.55, 0.055), (0.675, 0.19), (1, 1) */
    EaseInCubic,
    /* bezier cubic curve from points (0, 0), (0.645, 0.045, 0.355, 1), (1, 1) */
    EaseOutCubic,
    /* bezier cubic curve from points (0, 0), (0.645, 0.045, 0.355, 1), (1, 1) */
    EaseInOutCubic,
    /* bezier cubic curve from points (0, 0), (0.895, 0.03), (0.685, 0.22), (1, 1) */
    EaseInQuart,
    /* bezier cubic curve from points (0, 0), (0.165, 0.84), (0.44, 1), (1, 1) */
    EaseOutQuart,
    /* bezier cubic curve from points (0, 0), (0.77, 0), (0.175, 1), (1, 1) */
    EaseInOutQuart,
    /* bezier cubic curve from points (0, 0), (0.755, 0.05), (0.855, 0.06), (1, 1) */
    EaseInQuint,
    /* bezier cubic curve from points (0, 0), (0.23, 1), (0.32, 1), (1, 1) */
    EaseOutQuint,
    /* bezier cubic curve from points (0, 0), (0.86, 0), (0.07, 1), (1, 1) */
    EaseInOutQuint,
    /* bezier cubic curve from points (0, 0), (0.95, 0.05), (0.795, 0.035), (1, 1) */
    EaseInExpo,
    /* bezier cubic curve from points (0, 0), (0.19, 1), (0.22, 1), (1, 1) */
    EaseOutExpo,
    /* bezier cubic curve from points (0, 0), (1, 0), (0, 1), (1, 1) */
    EaseInOutExpo,
    /* bezier cubic curve from points (0, 0), (0.6, 0.04), (0.98, 0.335), (1, 1) */
    EaseInCirc,
    /* bezier cubic curve from points (0, 0), (0.075, 0.82), (0.165, 1), (1, 1) */
    EaseOutCirc,
    /* bezier cubic curve from points (0, 0), (0.785, 0.135), (0.15, 0.8), (1, 1) */
    EaseInOutCirc,
    /* bezier cubic curve from points (0, 0), (0.6, -0.28), (0.735, 0.045), (1, 1) */
    EaseInBack,
    /* bezier cubic curve from points (0, 0), (0.175, 0.885), (0.32, 1.275), (1, 1) */
    EaseOutBack,
    /* bezier cubic curve from points (0, 0), (0.68, -0.55), (0.265, 1.55), (1, 1) */
    EaseInOutBack,
    /* curve of elastic progression */
    EaseInElastic,
    /* curve of elastic regression */
    EaseOutElastic,
    /* curve of elastic progression then regression */
    EaseInOutElastic,
    /* curve of bounce progression */
    EaseInBounce,
    /* curve of bounce regression */
    EaseOutBounce,
    /* curve of bounce progression then regression */
    EaseInOutBounce
  };
 
  SoSFEnum easingType;
 
  SoSFBool oneShotActive;
 
  SoSFFloat opacityDistanceMin;
 
  SoSFFloat opacityDistanceMax;
};