X3DViewpointNode.h

Go to the documentation of this file.

//    Copyright 2004-2019, SenseGraphics AB
//
//    This file is part of H3D API.
//
//    H3D API is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    H3D API 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 General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with H3D API; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//    A commercial license is also available. Please contact us at 
//    www.sensegraphics.com for more information.
//
//
//
#ifndef __X3DX3DViewpointNodeNODE_H__
#define __X3DX3DViewpointNodeNODE_H__
 
#include <H3D/X3DBindableNode.h>
#include <H3D/FieldTemplates.h>
#include <H3DUtil/Exception.h>
#include <H3D/SFVec3f.h>
#include <H3D/SFString.h>
#include <H3D/SFFloat.h>
#include <H3D/SFRotation.h>
#include <H3D/SFMatrix4f.h>
#include <H3D/StereoInfo.h>
 
namespace H3D {
  class H3DAPI_API X3DViewpointNode : public X3DBindableNode {
  public:
 
    enum EyeMode {
      MONO = 0,
      LEFT_EYE = 1,
      RIGHT_EYE = 2,
      BOTH_EYE = 3
    };
 
    class H3DAPI_API SFPosition:  public SFVec3f {
    public:
      virtual void setValue( const Vec3f &v, int _id = 0 ) {
        SFVec3f::setValue( v, _id );
        X3DViewpointNode * temp_owner =
          static_cast< X3DViewpointNode * >( getOwner() );
        temp_owner->relPos->setValue( Vec3f() );
        temp_owner->relOrn->setValue( Rotation() );
      }
 
    protected:
      virtual void update() {
        SFVec3f::update();
        X3DViewpointNode * temp_owner =
          static_cast< X3DViewpointNode * >( getOwner() );
        temp_owner->relPos->setValue( Vec3f() );
        temp_owner->relOrn->setValue( Rotation() );
      }
    };
#ifdef __BORLANDC__
    friend class SFPosition;
#endif
 
    class H3DAPI_API SFOrientation:  public SFRotation {
    public:
      virtual void setValue( const Rotation &v, int _id = 0 ) {
        SFRotation::setValue( v, _id );
        X3DViewpointNode * temp_owner =
          static_cast< X3DViewpointNode * >( getOwner() );
        temp_owner->relPos->setValue( Vec3f() );
        temp_owner->relOrn->setValue( Rotation() );
      }
 
    protected:
      virtual void update() {
        SFRotation::update();
        X3DViewpointNode * temp_owner =
          static_cast< X3DViewpointNode * >( getOwner() );
        temp_owner->relPos->setValue( Vec3f() );
        temp_owner->relOrn->setValue( Rotation() );
      }
    };
#ifdef __BORLANDC__
    friend class SFOrientation;
#endif
 
    class H3DAPI_API SFSumVec3f: 
      public TypedField< SFVec3f, Types< SFPosition, SFVec3f > > {
    protected:
      virtual void update() {
        SFVec3f::update();
        value = static_cast< SFPosition * >( routes_in[0] )->getValue() +
                static_cast< SFVec3f * >( routes_in[1] )->getValue();
      }
    };
#ifdef __BORLANDC__
    friend class SFSumVec3f;
#endif
 
    class H3DAPI_API SFSumRotation: public TypedField< SFRotation,
      Types< SFOrientation, SFRotation > > {
    protected:
      virtual void update() {
        SFRotation::update();
        Rotation temp_rot =
          static_cast< SFOrientation * >( routes_in[0] )->getValue();
        temp_rot.axis.normalizeSafe();
        value = temp_rot *
                static_cast< SFRotation * >( routes_in[1] )->getValue();
      }
    };
#ifdef __BORLANDC__
    friend class SFSumRotation;
#endif
 
    X3DViewpointNode( Inst< SFSetBind     > _set_bind          = 0,
                      Inst< SFVec3f       > _centerOfRotation  = 0,
                      Inst< SFString      > _description       = 0,
                      Inst< SFBool        > _jump              = 0,
                      Inst< SFNode        > _metadata          = 0,
                      Inst< SFOrientation > _orientation       = 0,
                      Inst< SFPosition    > _position          = 0,
                      Inst< SFBool        > _retainUserOffsets = 0,
                      Inst< SFTime        > _bindTime          = 0,
                      Inst< SFBool        > _isBound           = 0,
                      Inst< SFMatrix4f    > _accForwardMatrix  = 0,
                      Inst< SFMatrix4f    > _accInverseMatrix  = 0,
                      Inst< SFSumVec3f    > _totalPosition     = 0,
                      Inst< SFSumRotation > _totalOrientation  = 0 );
 
    virtual ~X3DViewpointNode() {
      removeFromStack();
      viewpoints.remove( this );
      viewpoints_changed = true;
    }
 
    virtual void traverseSG( TraverseInfo &ti );
 
    static inline X3DViewpointNode *getActive() {
      return static_cast< X3DViewpointNode * >( 
              X3DBindableNode::getActive( "X3DViewpointNode" ) );
    }
 
    virtual bool windowFromfieldOfView( H3DFloat width, H3DFloat height,
                                        H3DFloat clip_near,
                                        H3DFloat &top, H3DFloat &bottom,
                                        H3DFloat &right, H3DFloat &left )
#ifndef H3D_GENERATE_DOTROUTE_FILES
                                        = 0;
#else
    { return false; }
#endif
 
    virtual void toStackTop();
 
    virtual void removeFromStack();
 
    virtual void rotateAround( Rotation rotation, bool collision,
                               Vec3f rotation_center );
 
    // Function for rotating the viewpoint around rotation_center = position
    virtual void rotateAroundSelf( Rotation rotation );
 
    virtual void translate( Vec3f direction, bool collision,
                            const vector< H3DFloat > &avatar_size,
                            X3DChildNode * topNode );
 
    virtual void moveTo( Vec3f new_pos );
 
    virtual bool detectCollision( const vector< H3DFloat > &avatar_size,
                                  X3DChildNode * topNode );
 
    typedef list< X3DViewpointNode * > ViewpointList;
    
    static const ViewpointList &getAllViewpoints() {
      return viewpoints;
    }
    
    static bool viewpointsChanged() {
      bool status = viewpoints_changed;
      viewpoints_changed = false;
      return status;
    }
 
    virtual void setupProjection( EyeMode eye_mode,
                                  H3DFloat width, H3DFloat height,
                                  H3DFloat clip_near, H3DFloat clip_far,
                                  StereoInfo * stereo_info = 0,
                                  bool update_stereo_proj_shift = false )
#ifndef H3D_GENERATE_DOTROUTE_FILES
                                        = 0;
#else
    {}
#endif
 
    virtual Matrix4f getProjectionMatrix( EyeMode eye_mode,
                                  H3DFloat width, H3DFloat height,
                                  H3DFloat clip_near, H3DFloat clip_far,
                                  StereoInfo * stereo_info = 0,
                                  bool mirrored_in_y = false );
 
    virtual void setupViewMatrix( EyeMode eye_mode,
                                  StereoInfo * stereo_info = 0,
                                  bool update_stereo_view_shift = false  ); 
 
 
    virtual Matrix4f getViewMatrix( EyeMode eye_mode,
                                    StereoInfo * stereo_info = 0 );
 
    inline bool isTopLevel() {
      return is_top_level;
    }
 
    inline bool inSceneGraph() {
      return in_scene_graph;
    }
 
    H3DUniquePtr< SFVec3f    > centerOfRotation;
 
    H3DUniquePtr< SFString   > description;
 
    H3DUniquePtr< SFBool     > jump;
 
    H3DUniquePtr< SFOrientation > orientation;
    
    H3DUniquePtr< SFPosition > position;
 
    H3DUniquePtr< SFBool    > retainUserOffsets;
 
    H3DUniquePtr< SFMatrix4f > accForwardMatrix;
 
    H3DUniquePtr< SFMatrix4f > accInverseMatrix;
 
    H3DUniquePtr< SFSumVec3f > totalPosition;
 
    H3DUniquePtr< SFSumRotation > totalOrientation;
    
    static H3DNodeDatabase database;
 
    H3DUniquePtr< SFVec3f > relPos;
 
    H3DUniquePtr< SFRotation > relOrn;
 
  protected:
    static ViewpointList viewpoints;
    static bool viewpoints_changed;
 
    bool is_top_level;
 
    bool in_scene_graph;
 
    // Internal function for easier calculations of parameters sent to
    // glFrustum or glOrtho. For usage see function setupProjection in
    // Viewpoint or OrthoViewpoint.
    void getProjectionDimensions( EyeMode eye_mode,
                                  H3DFloat width,
                                  H3DFloat height,
                                  H3DFloat clip_near,
                                  H3DFloat &top,
                                  H3DFloat &bottom,
                                  H3DFloat &right,
                                  H3DFloat &left,
                                  StereoInfo * stereo_info = 0,
                                  bool update_stereo_proj_shift = false );
 
  };
}
 
#endif