display_types.h

Go to the documentation of this file.

/*! \file
  \brief  GL Studio Enumerations and constants.
 
  \par Copyright Information
 
  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>
 
  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.
 
  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
 
  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).
 
  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.
 
*/
#ifndef _DISPLAY_TYPES_H
#define _DISPLAY_TYPES_H
 
#include "gls_include.h"
 
namespace disti
{
#define NUM_TEXTURE_POINTS 4 ///< Number of texture points per object.
 
#define OBJECT_SETTING_UNDEFINED -1 ///< Default value to returned for an undefined setting.
 
/** Enumeration for texture mapping mode of the object */
typedef enum
{
    TEXTURE_MAP_MODULATE, /**< Texture color and alpha are modulated with polygon color and alpha */
    TEXTURE_MAP_DECAL,    /**< Texture color is blended with polygon color */
    TEXTURE_MAP_BLEND,    /**< Texture color is blended with polygon color, texture alpha is modulated with polygon alpha */
    TEXTURE_MAP_REPLACE   /**< Texture color and alpha replace polygon color and alpha */
} TextureMap_e;
 
/** Enumeration for texture filtering mode of the object */
typedef enum
{
    TEXTURE_FILTER_NEAREST,                /**< Nearest pixel filtering */
    TEXTURE_FILTER_LINEAR,                 /**< Bilinear interpolation filtering */
    TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST, /**< Selects nearest pixel in the nearest mipmap */
    TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR,   /**< Linearly interpolates in two mipmaps then linearly interpolates between them */
    TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR,  /**< Selects nearest pixel in two mipmaps then linearly interpolates between them */
    TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST   /**< Linearly interpolates in the nearest mipmap */
} TextureFilter_e;
 
/** Enumeration for the Depth Testing and Writting mode */
typedef enum
{
    DEPTH_BUFFER_NO_TEST_NO_WRITE = 0, //Save as 0 for compatability /**< Doesn't Test or Write */
    DEPTH_BUFFER_TEST_AND_WRITE,       //Save as 1 for compatability       /**< Both Tests and Writes */
    DEPTH_BUFFER_TEST_NO_WRITE,        /**< Tests but doesn't write */
    DEPTH_BUFFER_NO_TEST_AND_WRITE     /**< Doesn't test but does write*/
} DepthBuffer_e;
 
/** Enumeration for polygon drawing mode of the object */
typedef enum
{
    POLY_MODE_UNDEFINED,       /**< Polygon draw style is not defined; not a drawable type.  Used with the properties page */
    POLY_MODE_POINTS,          /**< Polygon will be rendered with a point at each vertex */
    POLY_MODE_OUTLINE,         /**< Polygon will be rendered as an outline */
    POLY_MODE_FILLED,          /**< Polygon will be rendered filled-in */
    POLY_MODE_FILL_AND_OUTLINE /**< Polygon will be rendered filled-in and with an outline */
} PolygonMode_e;
 
/** Enumeration for Alpha Blending/Testing mode */
typedef enum
{
    ALPHA_MODE_UNDEFINED, /**< Alpha mode is not defined.  Used by the properties page */
    ALPHA_MODE_OPAQUE,    /**< Alpha testing and blending are disabled */
    ALPHA_MODE_2_LEVEL,   /**< Alpha testing with a threshold of 0.5 is enabled, alpha blending is enabled. */
    ALPHA_MODE_256_LEVEL  /**< Alpha blending is enabled, alpha testing is disabled. */
} AlphaMode_e;
 
/** Enumeration for whether or not polygon is closed or open */
typedef enum
{
    POLY_OPEN,  /**< Polygon will be drawn open */
    POLY_CLOSED /**< Polygon will be drawn closed */
} PolygonClose_e;
 
/** Enumeration for the type of rendering projection for a display frame */
typedef enum
{
    SHADING_FLAT,   /**< The object will be drawn with flat shading (monochromatic) */
    SHADING_GOURAUD /**< The object will be drawn with gouraud shading (linear color interpolation) */
} ShadingType_e;
 
/** Enumeration for the C++ protection status of an object */
typedef enum
{
    PUBLIC,   /**< The object will be C++ public status    */
    PRIVATE,  /**< The object will be C++ private status   */
    PROTECTED /**< The object will be C++ protected status */
} MemberAccess_e;
 
/** Enumeration for the redraw behavior for a display frame */
typedef enum
{
    REDRAW_CONDITIONAL, /**< The display frame is only redrawn when the scene changes */
    REDRAW_CONSTANT,    /**< The display frame is constantly redrawn at a specified rate */
    REDRAW_CONTINUOUS   /**< The display frame is constantly redrawn as fast as possible */
} RedrawBehavior_e;
 
/** Enumeration for the type of picking for an object */
typedef enum
{
    PICK_NEVER, /**< Picking will be disabled for this object and all children */
    PICK_FIRST, /**< Picking will be based on draw order only.  The first geometry hit wins. */
    PICK_BEST,  /**< Picking will find the best geometry hit of all available children */
    PICK_ALWAYS /**< Picking will ignore geometry of this object, and always return a pick as if hit.
                     This is still only found through normal draw order traversal.*/
} PickableType_e;
 
/** Enumeration for an object's usage of glColorMaterial */
typedef enum
{
    NO_COLOR_MATERIAL,                  /**< glColorMaterial will be disabled for the object */
    DIFFUSE_COLOR_MATERIAL,             /**< glColorMaterial will be enabled for the diffuse material */
    AMBIENT_COLOR_MATERIAL,             /**< glColorMaterial will be enabled for the ambient material */
    DIFFUSE_AND_AMBIENT_COLOR_MATERIAL, /**< glColorMaterial will be enabled for the diffuse & ambient materials */
    EMISSION_COLOR_MATERIAL,            /**< glColorMaterial will be enabled for the emission material */
    SPECULAR_COLOR_MATERIAL             /**< glColorMaterial will be enabled for the specular material */
} ColorMaterialMode_e;
 
/////////////////////////////////////////////////////////////////////////
//
// Default field values
//
/////////////////////////////////////////////////////////////////////////
#define DEF_WINDOW_SIZE 500      ///< Default application window width and height.
#define DEF_FILE_NAME "Untitled" ///< Default GLS design file name.
 
#define DEF_LINE_RCOLOR 0  ///< Default red channel for object outlines.
#define DEF_LINE_GCOLOR 0  ///< Default green channel for object outlines.
#define DEF_LINE_BCOLOR 0  ///< Default blue channel for object outlines.
#define DEF_LINE_ALPHA 255 ///< Default alpha channel for object outlines.
 
#define DEF_FILL_RCOLOR 255 ///< Default red channel for object fill.
#define DEF_FILL_GCOLOR 255 ///< Default green channel for object fill.
#define DEF_FILL_BCOLOR 255 ///< Default blue channel for object fill.
#define DEF_FILL_ALPHA 255  ///< Default alpha channel for object fill.
 
#define DEF_GRID_RCOLOR 0  ///< Default red channel for the editor canvas grid.
#define DEF_GRID_GCOLOR 0  ///< Default green channel for the editor canvas grid.
#define DEF_GRID_BCOLOR 0  ///< Default blue channel for the editor canvas grid.
#define DEF_GRID_ALPHA 255 ///< Default alpha channel for the editor canvas grid.
 
#define DEF_AXES_RCOLOR 0  ///< Default red channel for the editor canvas axes.
#define DEF_AXES_GCOLOR 0  ///< Default green channel for the editor canvas axes.
#define DEF_AXES_BCOLOR 0  ///< Default blue channel for the editor canvas axes.
#define DEF_AXES_ALPHA 255 ///< Default alpha channel for the editor canvas axes.
 
#define DEF_TEXTURE_BLEND_RCOLOR 255 ///< Default red channel for texture blending.
#define DEF_TEXTURE_BLEND_GCOLOR 255 ///< Default green channel for texture blending.
#define DEF_TEXTURE_BLEND_BCOLOR 255 ///< Default blue channel for texture blending.
#define DEF_TEXTURE_BLEND_ALPHA 255  ///< Default alpha channel for texture blending.
 
#define DEF_BACKGROUND_RCOLOR 160 ///< Default red channel for editor canvas, and application clear color.
#define DEF_BACKGROUND_GCOLOR 168 ///< Default green channel for editor canvas, and application clear color.
#define DEF_BACKGROUND_BCOLOR 176 ///< Default blue channel for editor canvas, and application clear color.
#define DEF_BACKGROUND_ALPHA 255  ///< Default alpha channel for editor canvas, and application clear color.
 
#define DEF_LIGHT_COLOR 255 ///< Unused, remains for backward compatibility.
 
#define DEF_LINE_WIDTH 1.0             ///< Default width in pixels for object outlines.
#define DEF_LINE_STIPPLE_PATTERN 65535 ///< Default line stipple pattern (solid).
#define DEF_LINE_STIPPLE_MULTIPLIER 1  ///< Default line stipple multiplier.
 
#define DEF_QUAD_WIDTH 25.0  ///< Unused, remains for backward compatibility.
#define DEF_QUAD_HEIGHT 25.0 ///< Unused, remains for backward compatibility.
 
#define DEF_CIRCLE_WIDTH 25.0                           ///< Unused, remains for backward compatibility.
#define DEF_CIRCLE_HEIGHT 25.0                          ///< Unused, remains for backward compatibility.
#define DEF_SHADING SHADING_FLAT                        ///< Default shading model for objects.
#define DEF_LIGHTING_ENABLED 0                          ///< Default lighting state for objects.
#define DEF_USE_PARENT_LIGHTING true                    ///< Default parent lighting for objects.
#define DEF_POLY_MODE POLY_MODE_OUTLINE                 ///< Default draw mode for objects.
#define DEF_POLY_END POLY_CLOSED                        ///< Default to drawing closed polygons.
#define DEF_TEXTURE_REPEAT TRUE                         ///< Default texture repeat state for objects.
#define DEF_TEXTURE_MAGNIFICATION TEXTURE_FILTER_LINEAR ///< Default texture magnification for objects.
#define DEF_TEXTURE_MINIFICATION TEXTURE_FILTER_LINEAR  ///< Default texture minification for objects.
#define DEF_TEXTURE_MAP TEXTURE_MAP_REPLACE             ///< Default texture mapping mode for objects.
#define DEF_POLYGON_MIN_DIMENSION 1                     ///< Unused, remains for backward compatibility.
 
#define DEF_POLYGON_OFFSET 0 ///< Unused, remains for backward compatibility.
 
#define DEF_DOUBLE_CLICK 500         ///< Editor canvas double click interval, in milliseconds.
#define DEF_DOUBLE_CLICK_TOLERANCE 5 ///< Editor canvas location tolerance, in logical units.
 
#define DEF_STATIC_FLAG FALSE                  ///< Unused, remains for backward compatibility.
#define DEF_ALPHAMODE ALPHA_MODE_256_LEVEL     ///< Default alpha test mode for objects.
#define DEF_VISIBILITY TRUE                    ///< Default visibility for objects.
#define DEF_CULLBACKFACE FALSE                 ///< Default backface drawing mode for objects.
#define DEF_ZBUFFER DEPTH_BUFFER_TEST_NO_WRITE ///< Default depth buffer write mode for objects.
#define DEF_ANTIALIAS FALSE                    ///< Default anti alias state for objects.
#define DEF_CIRCLE_SEGMENTS 30                 ///< Unused, remains for backward compatibility.
#define DEF_PROTECTION_MODE PUBLIC             ///< Default variable protection mode for objects.
#define DEF_ARC_ANGLE_AMOUNT 90.0              ///< Unused, remains for backward compatibility.
#define DEF_ARC_START_ANGLE 270.0              ///< Unused, remains for backward compatibility.
#define DEF_PROJECTION ORTHOGRAPHIC            ///< Unused, remains for backward compatibility.
#define DEF_BUFFER DOUBLE_BUFFER               ///< Unused, remains for backward compatibility.
#define DEF_FRAME_RATE 30                      ///< Default framerate for applications.
#define DEF_REDRAW REDRAW_CONSTANT             ///< Default redraw behavior for applications.
#define DEF_BLINK false                        ///< Default blink mode for objects.
#define DEF_BLINK_RATE 2.0                     ///< Default blink rate for objects in seconds.
#define DEF_PICKABLE PICK_FIRST                ///< Default pick mode for objects.
#define DEF_MATERIAL_INDEX 0                   ///< Default material index for objects.
 
#define DEF_TEXTURE_PALETTE_SIZE 50 ///< Unused, remains for backward compatibility.
 
static const int MULTIPLE_TEXTURES_ON_OBJECT = -2; ///< Special value to denote multiple textures are present on an object (like a mesh).
 
//////////////////////////////////////////////////////////////////////////
//
// "View" of a window, either in runtime or in the editor
//
//////////////////////////////////////////////////////////////////////////
/**
    View
*/
enum Views
{
    VIEW_XY          = 1,
    VIEW_XZ          = 2,
    VIEW_ZY          = 4,
    VIEW_PERSPECTIVE = 8,
    VIEW_EYEPOINT    = 16
};
 
//////////////////////////////////////////////////////////////////////////
//
// Used in Generated Code
//
//////////////////////////////////////////////////////////////////////////
/**
    Initializers
*/
typedef enum
{
    GLS_INSTANCE_NAME = 1,
    GLS_LOCATION,
    GLS_ROTATION_POINT,
    GLS_ACTION_CALLBACK,
    GLS_OBJECT_NAME,
    GLS_ATTRIBUTE_NAME,
    GLS_TEXTURE_INDEX,
    GLS_TEXTURE_REPEAT,
    GLS_TEXTURE_MAP_MODE,
    GLS_TEXTURE_MIN_FILTER,
    GLS_TEXTURE_MAG_FILTER,
    GLS_TEXTURE_BLEND_COLOR,
    GLS_TEXTURE_ROTATION,
    GLS_TEXTURE_SCALE_H,
    GLS_TEXTURE_SCALE_V,
    GLS_TEXTURE_OFFSET_X,
    GLS_TEXTURE_OFFSET_Y,
    GLS_POLYGON_MODE,
    GLS_POLYGON_END,
    GLS_POLYGON_OFFSET,
    GLS_COLOR,
    GLS_COLOR_MATERIAL_MODE,
    GLS_LINE_WIDTH,
    GLS_LINE_STIPPLE_PATTERN,
    GLS_LINE_STIPPLE_MULTIPLIER,
    GLS_VISIBILITY,
    GLS_CULLBACKFACE,
    GLS_ALPHAMODE,
    GLS_ANTIALIAS,
    GLS_ZBUFFER,
    GLS_SHADING,
    GLS_BLINKING,
    GLS_BLINK_RATE,
    GLS_PICKABLE,
    GLS_LIGHTING_ENABLED,
    GLS_MATERIAL_INDEX,
    GLS_MATERIAL_INDICES,
    GLS_DCS_MATRIX,
    GLS_COMPONENT_ABSOLUTE_PLACEMENT,
    GLS_COMPONENT_EDITOR_TRANSFORM,
    GLS_TEXTURE_POINTS,
    GLS_LAST_INITIALIZER
} GLS_Initializers;
 
} // namespace disti
 
#endif