---

S5object.h

Go to the documentation of this file.

// ///////////////////  ***********************  \\\\\\\\\\\\\\\\\\\\ \\
//
//  This file is part of the Sector 5, 3D graphic game.
//  Copyright (C) 2000-2002 by PC John. All rights reserved.
//
//  This game is free software; you can redistribute it and/or
//  modify it under the terms of the GNU Lesser General Public License
//  version 2.1 as published by the Free Software Foundation. See the
//  file LICENSE.LGPL at the root directory of the distribution for
//  more details.
//
//  If you want to use Sector 5 code for applications not compatible 
//  with the LGPL license, please contact PC John at pcjohn@email.cz.
//
// \\\\\\\\\\\\\\\\\\\  ***********************  //////////////////// //


#ifndef S5_OBJECT_H_INCLUDED_
#define S5_OBJECT_H_INCLUDED_

#include <Inventor/nodes/SoSwitch.h>
#include <Inventor/nodes/SoMatrixTransform.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/SbTime.h>

class S5camera;



// functions for matrix decomposition
inline SbVec3f matrixGetTranslation(const SbMatrix m)  { return SbVec3f(m[3][0], m[3][1], m[3][2]); }
inline void matrixGetTranslation(const SbMatrix m, float &x, float &y, float &z)  { x=m[3][0]; y=m[3][1]; z=m[3][2]; }
inline void matrixSetTranslation(SbMatrix &m, const SbVec3f vec)  { m[3][0]=vec[0]; m[3][1]=vec[1]; m[3][2]=vec[2]; }
inline void matrixSetTranslation(SbMatrix &m, const float x, const float y, const float z)  { m[3][0]=x; m[3][1]=y; m[3][2]=z; }

inline SbVec3f matrixGetVecAhead(const SbMatrix m)  { return SbVec3f(-m[2][0], -m[2][1], -m[2][2]); }
inline void matrixSetVecAhead(SbMatrix &m, const SbVec3f vec)  { m[2][0]=-vec[0]; m[2][1]=-vec[1]; m[2][2]=-vec[2]; }

inline SbVec3f matrixGetVecRight(const SbMatrix m)  { return SbVec3f(m[0][0], m[0][1], m[0][2]); }
inline void matrixSetVecRight(SbMatrix &m, const SbVec3f vec)  { m[0][0]=vec[0]; m[0][1]=vec[1]; m[0][2]=vec[2]; }

inline SbVec3f matrixGetVecUp(const SbMatrix m)  { return SbVec3f(m[1][0], m[1][1], m[1][2]); }
inline void matrixSetVecUp(SbMatrix &m, const SbVec3f vec)  { m[1][0]=vec[0]; m[1][1]=vec[1]; m[1][2]=vec[2]; }



class S5object : public SoSwitch
{

  SO_NODE_HEADER(S5object);

public:

  SoSFFloat collisionRadius;

  // set/get transformation matrix
  void getMatrix(SbMatrix &m) const  { matrixTransform->matrix.getValue().getValue(m); };
  const SbMatrix& getMatrix() const  { return matrixTransform->matrix.getValue(); };
  void setMatrix(const SbMatrix m)  { matrixTransform->matrix.setValue(m); };

  // helper functions for transformation matrix decomposition
  SbVec3f getTranslation() const  { return matrixGetTranslation(getMatrix()); };
  SbVec3f getDirectionAhead() const  { return matrixGetVecAhead(getMatrix()); };
  SbVec3f getDirectionRight() const  { return matrixGetVecRight(getMatrix()); };
  SbVec3f getDirectionUp() const  { return matrixGetVecUp(getMatrix()); };

  // rotation functions
  void rotate(const float heading, const float pitch, const float roll = 0.f);
  
  // helper functions for setting position
  void setTranslation(SbVec3f vec)  { SbMatrix m(getMatrix()); matrixSetTranslation(m, vec); setMatrix(m); };
  void setTranslation(float x, float y, float z)  { SbMatrix m(getMatrix()); matrixSetTranslation(m, x,y,z); setMatrix(m); };

  // functions for setting/getting object representation
  SoNode* getGraph()  { return graph; };
  void setGraph(SoNode *g);

  SbBool getVisibility()  { return visible; };
  void setVisibility(SbBool newVisibility);
  
  // functions returns object's transtormation and position 
  // in world space coordinates
  SbMatrix getTransformation();
  SbVec3f getPosition()  { return matrixGetTranslation(getTransformation()); };
  
  void attachCamera(S5camera *newCamera);
  void detachCamera()  { attachCamera(NULL); }
        S5camera* getCamera()  { return camera; };


  static void performTimeTick(SbTime dt);

  virtual void timeTick(SbTime dt)  {};

        S5object();

public:

  S5object* getNext()  { return next; };
  S5object* getPrev()  { return prev; };
  static S5object* getFirst()  { return first; };
  static S5object* getLast()  { return last; };

private:

  void insertToList();
  void removeFromList();
  
  S5object *next;
  S5object *prev;
  static S5object *first;
  static S5object *last;

SoINTERNAL public:

  SbBool getVisibilityForCameras()  { return visibleForCameras; };
  void setVisibilityForCameras(SbBool newVisibility);
  
  static void initClass();

protected:

  virtual SbBool readInstance(SoInput * in, unsigned short flags);

  virtual ~S5object();

  void doShow();
  void doHide();

  SoSeparator *separator;
  SoMatrixTransform *matrixTransform;
  SoNode *graph;

        SbBool visible;
  SbBool visibleForCameras;

  friend S5camera;
  S5camera *camera; // FIXME: have to be the camera stored in the file?  2002-02-13 PCJohn

};


#endif /* S5_OBJECT_H_INCLUDED_ */

---