basic/geometry/Frame.h

Go to the documentation of this file.

//## begin module%36FE7C26037A.cm preserve=no
//        %X% %Q% %Z% %W%
//## end module%36FE7C26037A.cm

//## begin module%36FE7C26037A.cp preserve=no
//## end module%36FE7C26037A.cp

//## Module: Frame%36FE7C26037A; Pseudo Package specification
//## Source file: C:\user\gipson\projects\mpk\code\geometry\Frame.h

#ifndef Frame_h
#define Frame_h 1

//## begin module%36FE7C26037A.additionalIncludes preserve=no
//## end module%36FE7C26037A.additionalIncludes

//## begin module%36FE7C26037A.includes preserve=yes
//## end module%36FE7C26037A.includes

// Matrix4x4
#include <math\Matrix4x4.h>

class Vector4;

//## begin module%36FE7C26037A.additionalDeclarations preserve=yes
//## end module%36FE7C26037A.additionalDeclarations


//## begin Frame%36FE7C26037A.preface preserve=yes
//## end Frame%36FE7C26037A.preface

//## Class: Frame%36FE7C26037A
//      class for representing reference frames
//## Category: geometry%36FE7BDE030C
//## Persistence: Transient
//## Cardinality/Multiplicity: n

//## Uses: <unnamed>%379638E00246;Vector4 { -> F}

class Frame : public Matrix4x4  //## Inherits: <unnamed>%36FE7C340208
{
  //## begin Frame%36FE7C26037A.initialDeclarations preserve=yes
  //## end Frame%36FE7C26037A.initialDeclarations

  public:
    //## Constructors (specified)
      //## Operation: Frame%923117054
      Frame ();

      //## Operation: Frame%926014532
      Frame (const Matrix4x4& right);

    //## Destructor (generated)
      virtual ~Frame();


    //## Other Operations (specified)
      //## Operation: SetBaseFrame%923117055
      void SetBaseFrame (const unsigned int base);

      //## Operation: BaseFrameNum%923117056
      //        returns the frame number of the base frame to this frame
      //        - all frames must be defined in another frame
      unsigned int BaseFrameNum () const;

      //## Operation: operator<%945198430
      bool operator < (const Frame& right) const;

      //## Operation: EvaluateOverall%923255743
      //        computes the frame in relation to the root of the entire
      //        tree
      Frame EvaluateOverall () const;

      //## Operation: GetTranslationVector%926300305
      Vector4 GetTranslationVector () const;

      //## Operation: operator==%945198431
      bool operator == (const Frame& right) const;

    // Additional Public Declarations
      //## begin Frame%36FE7C26037A.public preserve=yes
          Frame( const Frame& right ) ;
          Frame& operator =( const Frame& right ) ;
      //## end Frame%36FE7C26037A.public
  protected:
    // Additional Protected Declarations
      //## begin Frame%36FE7C26037A.protected preserve=yes
          char name[ 256 ] ;
      //## end Frame%36FE7C26037A.protected
  private:
    // Data Members for Class Attributes

      //## Attribute: baseFrame%37191E5B0212
      //## begin Frame::baseFrame%37191E5B0212.attr preserve=no  private: unsigned int {UA} 
      unsigned int baseFrame;
      //## end Frame::baseFrame%37191E5B0212.attr

    // Additional Private Declarations
      //## begin Frame%36FE7C26037A.private preserve=yes
      //## end Frame%36FE7C26037A.private

  private: //## implementation
    // Additional Implementation Declarations
      //## begin Frame%36FE7C26037A.implementation preserve=yes
      //## end Frame%36FE7C26037A.implementation

};

//## begin Frame%36FE7C26037A.postscript preserve=yes
//## end Frame%36FE7C26037A.postscript

// Class Frame 

//## begin module%36FE7C26037A.epilog preserve=yes
//## end module%36FE7C26037A.epilog


#endif

---