gls_vertex.h

Go to the documentation of this file.

#ifndef _GLS_VERTEX_H
#define _GLS_VERTEX_H

/*! \file gls_vertex.h
\brief  This header defines classes for working with 2D and 3D vectors, 
        vertices and textured vertices in
        the GL Studio DO-178B Runtime Library.

\par Copyright Information
Copyright (C) 1999-2012 The DiSTI Corporation<br>
Orlando, FL USA<br>
All rights reserved.<br>

  This file is copyrighted software and contains proprietary trade secrets of
DiSTI, and embodies substantial creative efforts as well as confidential
information, ideas, and expressions.

  Permission to use, and copy this software and its documentation for any
purpose is hereby granted per the Distribution Agreement and/or the Licensing
Agreement signed with DiSTI. This permission is granted provided that:
    1.  The above copyright notice appears in all copies.
    2.  That both the copyright notice and this permission notice appear in
        the supporting documentation.
    3.  That the names DiSTI and GL Studio not be used in advertising or
        publicity pertaining to distribution of the software without specific,
        written prior permission of DiSTI.
 
  Permission to modify the software is granted, but not the right to
distribute the source code whether modified, or non-modified.  Modifying the
software might invalidate the DO-178B certification package.

  Permission to distribute binaries produced by compiling source code, or
modified source code is granted, provided you:
    1.  Provide your name and address as the primary contact for the support
        of your modified version.
    2.  Retain our contact information in regard to use of the base software. 

   DiSTI does not provide warranty for this software or guarantee that it
satisfies any specification or requirement unless otherwise stated in a
specific contractual arrangement between the customer and DiSTI.

*/

#include "gls_include.h" 
#include "gls_types.h"
#include "gls_color.h"

/** A 2D coordinate */
struct GlsVector2D
{
    GlsFloat32 x; /**< x coordinate */
    GlsFloat32 y; /**< y coordinate */

    #if defined( GLS_DEBUG )
        /** Determine if this 2D vector has valid components
         * \return GLS_TRUE if valid else GLS_FALSE
         * \pre none
         * \post none
         */
        GlsBool IsValid( void ) const;
    #endif // GLS_DEBUG
};

/** A 3D coordinate */
struct GlsVector3D
{
    GlsFloat32 x; /**< x coordinate */
    GlsFloat32 y; /**< y coordinate */
    GlsFloat32 z; /**< z coordinate */

    #if defined( GLS_DEBUG )
        /** Determine if this 3D vector has valid components
         * \return GLS_TRUE if valid else GLS_FALSE
         * \pre none
         * \post none
         */
        GlsBool IsValid( void ) const;
    #endif // GLS_DEBUG
};

/** A homogeneous 3D coordinate */
struct GlsHomogeneousVector3D
{
    GlsFloat32 x; /**< x coordinate */
    GlsFloat32 y; /**< y coordinate */
    GlsFloat32 z; /**< z coordinate */
    GlsFloat32 w; /**< w coordinate */

    #if defined( GLS_DEBUG )
        /** Determine if this homogeneous 3D vector has valid components
         * \return GLS_TRUE if valid else GLS_FALSE
         * \pre none
         * \post none
         */
        GlsBool IsValid( void ) const;
    #endif // GLS_DEBUG
};

/** A 3D coordinate in space with an RGBA color value */
struct GlsVertex
{
    GlsVector3D coordinate; /**< 3D coordinate */
    GlsColor    color;      /**< color associated with the coordinate */

    #if defined( GLS_DEBUG )
        /** Determine if this vertex is valid
         * \pre none
         * \post none
         * \return GLS_TRUE if valid else GLS_FALSE
         */
        GlsBool IsValid( void ) const;
    #endif // GLS_DEBUG
};

/** A vertex with its corresponding texture coordinate */
struct GlsTextureVertex
{
    GlsVertex   vertex;            /**< coord, color */
    GlsVector2D textureCoordinate; /**< texture coordinate */

    #if defined( GLS_DEBUG )
        /** Determine if this texture vertex has valid components
         * \return GLS_TRUE if valid else GLS_FALSE
         * \pre none
         * \post none
         */
        GlsBool IsValid( void ) const;
    #endif // GLS_DEBUG
};

#if defined( GLS_DEBUG )
#pragma BullseyeCoverage save off
/* Determine if this 2D vector has valid components ( GLS_DEBUG only )
 * \return GLS_TRUE if valid else GLS_FALSE
 * \pre none
 * \post none
 */
inline GlsBool GlsVector2D::IsValid( void ) const
{
    return( GlsFloatIsValid( x ) && GlsFloatIsValid( y ) );
}
#pragma BullseyeCoverage restore
#endif // GLS_DEBUG

#if defined( GLS_DEBUG )
#pragma BullseyeCoverage save off
/* Determine if this 3D vector has valid components ( GLS_DEBUG only )
 * \return GLS_TRUE if valid else GLS_FALSE
 * \pre none
 * \post none
 */
inline GlsBool GlsVector3D::IsValid( void ) const
{
    return( GlsFloatIsValid( x ) && GlsFloatIsValid( y ) && GlsFloatIsValid( z ) );
}
#pragma BullseyeCoverage restore
#endif // GLS_DEBUG

#if defined( GLS_DEBUG )
#pragma BullseyeCoverage save off
/* Determine if this homogeneous 3D vector has valid components ( GLS_DEBUG only )
 * \return GLS_TRUE if valid else GLS_FALSE
 * \pre none
 * \post none
 */
inline GlsBool GlsHomogeneousVector3D::IsValid( void ) const
{
    return( GlsFloatIsValid( x ) && GlsFloatIsValid( y ) && GlsFloatIsValid( z ) && GlsFloatIsValid( w ) );
}
#pragma BullseyeCoverage restore
#endif // GLS_DEBUG

#if defined( GLS_DEBUG )
#pragma BullseyeCoverage save off
/* Determine if this vertex is valid ( GLS_DEBUG only )
 * \pre none
 * \post none
 * \return GLS_TRUE if valid else GLS_FALSE
 */
inline GlsBool GlsVertex::IsValid( void ) const
{
    return( coordinate.IsValid() && color.IsValid() );
}
#pragma BullseyeCoverage restore
#endif // GLS_DEBUG

#if defined( GLS_DEBUG )
#pragma BullseyeCoverage save off
/* Determine if this texture vertex has valid components ( GLS_DEBUG only )
 * \return GLS_TRUE if valid else GLS_FALSE
 * \pre none
 * \post none
 */
inline GlsBool GlsTextureVertex::IsValid( void ) const
{
    return( vertex.IsValid() && textureCoordinate.IsValid() );
}
#pragma BullseyeCoverage restore
#endif // GLS_DEBUG

#endif // _GLS_VERTEX_H