libcigicl-dev 3.3.3a+svn818-10ubuntu1 / usr / include / cigicl / CigiBaseCircleSymbolData.h

/** <pre>
 *  The SDK is used to create and format CIGI compliant messages.
 *  Copyright (c) 2001-2005 The Boeing Company
 *  
 *  This library is free software; you can redistribute it and/or modify it 
 *  under the terms of the GNU Lesser General Public License as published by 
 *  the Free Software Foundation; either version 2.1 of the License, or (at 
 *  your option) any later version.
 *  
 *  This library 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 Lesser Public License for more 
 *  details.
 *  
 *  You should have received a copy of the GNU Lesser General Public License 
 *  along with this library; if not, write to the Free Software Foundation, 
 *  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *  
 *  FILENAME:   CigiBaseCircleSymbolData.h
 *  LANGUAGE:   C++
 *  CLASS:      UNCLASSIFIED
 *  PROJECT:    Common Image Generator Interface (CIGI) SDK
 *  
 *  PROGRAM DESCRIPTION: 
 *  ...
 *  
 *  MODIFICATION NOTES:
 *  DATE     NAME                                SCR NUMBER
 *  DESCRIPTION OF CHANGE........................
 *  
 *  09/17/2003 Greg Basler                       CIGI_CR_DR_1
 *  Initial Release.
 *  
 * </pre>
 *  Author: The Boeing Company
 *
 */

#if !defined(_CIGI_BASE_CIRCLE_SYMBOL_DATA_INCLUDED_)
#define _CIGI_BASE_CIRCLE_SYMBOL_DATA_INCLUDED_


#include "CigiTypes.h"
#include "CigiErrorCodes.h"

// ====================================================================
// preprocessor definitions
// ====================================================================

#define CIGI_CIRCLE_SYMBOL_DATA_SIZE_V3_3 24


class CigiCircleSymbolDataV3_3;

//=========================================================
//! The base class for all packets.
//!
class CIGI_SPEC CigiBaseCircleSymbolData
{

   friend class CigiCircleSymbolDataV3_3;

public:


   //==> Management

   //=========================================================
   //! General Constructor
   //!
   CigiBaseCircleSymbolData(void);

   //=========================================================
   //! General Destructor
   //!
   virtual ~CigiBaseCircleSymbolData(void);


   //==> Buffer Packing/Unpacking

   //=========================================================
   //! A pure virtual Pack function.  
   //! This function is not implemented in this class.
   //! \param Base - A pointer to the instance of the Circle 
   //!          Data to be packed. (Downcast to CigiBaseCircleSymbolData)
   //! \param Buff - A pointer to the current pack point.
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   virtual int Pack(CigiBaseCircleSymbolData * Base, Cigi_uint8 * Buff) const=0;

   //=========================================================
   //! A pure virtual Unpack function.
   //! This function is not implemented in this class.
   //! \param Buff - A pointer to the current pack point.
   //! \param Swap - N/A for V1 & V2
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   virtual int Unpack(Cigi_uint8 * Buff, bool Swap) =0;


   //==> Accessing Member Variable Values functions


   //+> CenterUPosition

   //=========================================================
   //! Sets the CenterUPosition with bound checking control
   //! \param CenterUPositionIn - Specifies the position of
   //!   the center of the circle along the current U Axis.
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetCenterUPosition(const float CenterUPositionIn, bool bndchk=true)
   {
      CenterUPosition = CenterUPositionIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   //! Gets the CenterUPosition with bound checking control
   //! \return CenterUPosition
   //!
   float GetCenterUPosition(void) const { return(CenterUPosition); }


   //+> CenterVPosition

   //=========================================================
   //! Sets the CenterVPosition with bound checking control
   //! \param CenterVPositionIn - Specifies the position of
   //!   the center of the circle along the current V Axis.
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetCenterVPosition(const float CenterVPositionIn, bool bndchk=true)
   {
      CenterVPosition = CenterVPositionIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   //! Gets the CenterVPosition with bound checking control
   //! \return CenterVPosition
   //!
   float GetCenterVPosition(void) const { return(CenterVPosition); }


   //+> Radius

   //=========================================================
   //! Sets the Radius with bound checking control
   //! \param RadiusIn - Specifies the radius of the circle
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetRadius(const float RadiusIn, bool bndchk=true);

   //=========================================================
   //! Gets the Radius with bound checking control
   //! \return Radius
   //!
   float GetRadius(void) const { return(Radius); }


   //+> InnerRadius

   //=========================================================
   //! Sets the InnerRadius with bound checking control
   //! \param InnerRadiusIn - Specifies the inner radius of
   //!   a filled or partially filled circle.
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetInnerRadius(const float InnerRadiusIn, bool bndchk=true);

   //=========================================================
   //! Gets the InnerRadius with bound checking control
   //! \return InnerRadius
   //!
   float GetInnerRadius(void) const { return(InnerRadius); }


   //+> StartAngle

   //=========================================================
   //! Sets the StartAngle with bound checking control
   //! \param StartAngleIn - Specifies the angle from the
   //!   current X Axis that the circle starts.
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetStartAngle(const float StartAngleIn, bool bndchk=true);

   //=========================================================
   //! Gets the StartAngle with bound checking control
   //! \return StartAngle
   //!
   float GetStartAngle(void) const { return(StartAngle); }


   //+> EndAngle

   //=========================================================
   //! Sets the EndAngle with bound checking control
   //! \param EndAngleIn - Specifies the angle from the
   //!   current X Axis that the circle ends.
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetEndAngle(const float EndAngleIn, bool bndchk=true);

   //=========================================================
   //! Gets the EndAngle with bound checking control
   //! \return EndAngle
   //!
   float GetEndAngle(void) const { return(EndAngle); }



protected:

   //==> Member variables

   //=========================================================
   //! CenterUPosition<br>
   //! The position of the center of the circle along
   //!   the current U Axis.
   //!
   float CenterUPosition;

   //=========================================================
   //! CenterVPosition<br>
   //! The position of the center of the circle along
   //!   the current V Axis.
   //!
   float CenterVPosition;

   //=========================================================
   //! Radius<br>
   //! The radius of this circle
   //!
   float Radius;

   //=========================================================
   //! InnerRadius<br>
   //! The inner radius of a filled or partially filled circle
   //!
   float InnerRadius;

   //=========================================================
   //! StartAngle<br>
   //! The angle from the current X Axis where the circle
   //!  or arc starts.
   //!
   float StartAngle;

   //=========================================================
   //! StartAngle<br>
   //! The angle from the current X Axis where the circle
   //!  or arc ends.
   //!
   float EndAngle;


};



#endif   //  #if !defined(_CIGI_BASE_CIRCLE_SYMBOL_DATA_INCLUDED_)