gamepad-vgfx.h

Go to the documentation of this file.

/*
 * gamepad-vgfx.h
 *
 * Copyright (C) 2010  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Drawing gamepad Type objects using vector graphics engine (vgfx) in OpenGL
 */

#ifndef GAMEPAD_GAMEPAD_VGFX_H__
#define GAMEPAD_GAMEPAD_VGFX_H__

// includes --------------------------------------------------------------------
#include "gamepad/manager.h"
#include "vgfx/drawer.h"


namespace gamepad {


/// \ingroup gamepad_api
/// \defgroup gamepad_element Gamepad Dialog Elements
///
/*@{*/


/// use this object to render a particular gamepad Type -- assuming it has a
///     vgfx file.
class TypeVgfxRenderer {
public:
        // virtual destructor --------------------------------------------------
        virtual ~TypeVgfxRenderer(void) throw();

        // gamepad::TypeVgfxRenderer class interface methods -------------------

        /// set the intensity of the given control.  0 is completely faded out,
        ///     1 is full intensity.  Only values from 0 to 1 are allowed.
        virtual void setIntensity(IN const char * logical_name,
                                IN float intensity) = 0;

        /// sets position of the given control.  x and y vary from 0 to 1.
        ///     single-dimension controls (pots, buttons) only use the x value.
        virtual void setPosition(IN const char * logical_name,
                                IN float x, IN float y) = 0;

        virtual void draw(IN int xOffset, IN int yOffset,
                                IN int width, IN int height) = 0;

        // public static methods (factories) -----------------------------------
        static smart_ptr<TypeVgfxRenderer> create(IN Type * type,
                                IN smart_ptr<vgfx::Drawer>& drawer);
};



};      // gamepad namespace


#endif  // GAMEPAD_GAMEPAD_VGFX_H__