diguyGraphicsState.h

Go to the documentation of this file.

/*
 *  Copyright (C) 1992-2013 Boston Dynamics
 *  ALL RIGHTS RESERVED.
 *
 *  These coded instructions, statements, and computer programs
 *  contain unpublished proprietary information of Boston Dynamics
 *  and are protected by Copyright Laws of the United States.
 *  They may not be used, duplicated, or disclosed in any form, in
 *  whole or in part, without the prior written consent from Boston
 *  Dynamics.
 *
 *  RESTRICTED RIGHTS LEGEND
 *  Use, duplication, or disclosure by the government is subject
 *  to restrictions as set forth in FAR 52.227.19(c)(2) or
 *  subparagraph (c)(1)(ii) of the Rights in Technical Data and
 *  Computer Software clause at DFARS 252.227-7013 and/or in
 *  similar or successor clauses in the FAR, or the DOD or NASA
 *  FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the
 *  Commercial Computer Software--Restricted Rights at 48 CFR
 *  52.227-19, as applicable.  Unpublished-rights reserved under
 *  the Copyright Laws of the United States.
 *  Contractor/Manufacturer is:
 *  Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.
 */

/*********************************************************************/
#ifndef __diguyGraphicsState_H
#define __diguyGraphicsState_H

#ifdef SWIG
%module diguyGraphicsState
#else
#define CPLUSPLUS_ONLY
#endif

#ifdef CPLUSPLUS_ONLY
#include <diguy_constants.h>
#include <declspec_diguy.h>

// needed for diguyTextureMapType
#include <diguyGraphicsTexture.h>

class bdiGeometryGeosetState;
class diguyGraphicsState;
class diguyGraphicsMaterial;
class diguyGraphicsTexture;


#endif

/****************************************************************************/
class BDI_DECLSPEC_diguy diguyGraphicsState
{

public:

/*****************************************************************************/
        /*l
         *b  Description:
         **
         **    This function returns the material of this state.  Specific
         **    information about the material can then be accessed from
         **    the returned object.
         **
         *b  Returns:
         **
         **    object of type diguyGraphicsMaterial; NULL on failure
         **
         *b  Callable From:
         **
         *-    - C++
         */
        diguyGraphicsMaterial* get_material();

        /*l
         *b  Description:
         **
         **    This function returns the number of textures this state has.
         **
         *b  Returns:
         **
         **    number of textures associated with this state
         **
         *b  Callable From:
         **
         *-    - C++
         */
        int get_num_textures();

        /*l
         *b  Description:
         **
         **    This function returns the nth texture of this state.  Specific
         **    information about the texture can then be accessed from
         **    the returned object.
         **
         *b  Returns:
         **
         **    object of type diguyGraphicsTexture; NULL on failure
         **
         *b  Callable From:
         **
         *-    - C++
         */
        diguyGraphicsTexture* get_texture(int texture_index = 0);

        /*l
         *b  Description:
         **
         **    This function returns the way that a texture is used in the state.
         **    Possibilities include diffuse, specular, normal.
         **
         *b  Returns:
         **
         **    diguyTextureMapType enum
         **
         *b  Callable From:
         **
         *-    - C++
         */
        diguyTextureMapType get_texture_type(int index);

        /*l
         *b  Description:
         **
         **    This function returns a bit-wise or'ed mask of available textures
         **    in this state. Possibilities include DIGUY_TEXTURE_MAP_MASK_DIFFUSE,
         **    DIGUY_TEXTURE_MAP_MASK_SPECULAR, DIGUY_TEXTURE_MAP_MASK_BUMP,
         **    etc.  See diguyTextureMapMasks enum for a complete list.
         **
         */
        int get_textures_available();

        /*l
         *b  Description:
         **
         **    This function returns whether either the material or texture of
         **    this state contains an alpha component.  States that have an alpha
         **    component can make objects semi-transparent, which can affect when
         **    said objects should be drawn.
         **
         *b  Returns:
         **
         **    1 if state contains an alpha component, 0 if not; -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         */
        int get_contains_alpha_component();

        /*l
         *b  Description:
         **
         **    This function returns whether faces drawn with this state should
         **    be lit or unlit.
         **
         *b  Returns:
         **
         **    1 if faces unlit, 0 if lit, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         */
        int get_is_unlit();

        /*l
         *b  Description:
         **
         **    This function frees most memory allocated by the DI-Guy geometry
         **    loader for this object.
         **
         **    This function should only be called during or after the object's
         **    build() function has been called.  After it has been called, calls
         **    to many accessor functions will fail.
         **
         *b  Callable From:
         **
         *-    - C++
         */
        void free_loader_memory();



/*****************************************************************************/
#ifdef CPLUSPLUS_ONLY

        /*l
         *b  Description:
         **
         **    This function will be called by DI-Guy when it is time for a
         **    renderer-specific state object to be created.  A subclass of
         **    this class isn't always necessary, particularly for immediate
         **    mode renderers in which everything might be done in a subclass
         **    of diguyGraphicsMaterial and a subclass of diguyGraphicsTexture.
         **
         *i  Immediate Mode:
         **
         **    Immediate mode renderers usually do not override this function.
         **
         *i  Scene Graph:
         **
         **    Scene graph renderers may override this function, to
         **    create a state object that will be associated with
         **    diguyGraphicsMesh objects.
         **
         **    The subclass version of this function may need to refer to
         **    material and texture objects created by the build() calls
         **    of subclasses of diguyGraphicsMaterial and
         **    diguyGraphicsTexture objects.
         **
         *b  Callable From:
         **
         *-    - N/A (automatically called by DI-Guy Graphics API during
         *-      the Build Stage)
         */
        virtual void build();

        /*l
         *b  Description:
         **
         **    This function will be called by DI-Guy when it is time for a
         **    renderer-specific state object to be destroyed.
         **
         *i  Immediate Mode:
         **
         **    Immediate mode renderers may override this function, to
         **    destroy any object that may have been created by build().
         **
         *i  Scene Graph:
         **
         **    Scene graph renderers may override this function, to
         **    destroy any object that may have been created by build().
         **
         *b  Callable From:
         **
         *-    - N/A (automatically called by DI-Guy Graphics API during
         *-      the Unbuild Stage)
         */
        virtual void unbuild();

        /*l
         *b  Description:
         **
         **    This function will be called by DI-Guy when the state should
         **    be made active, or bound.
         **
         *i  Immediate Mode:
         **
         **    Immediate mode renderers can override this function, but
         **    may not need to.  The material and texture of the state
         **    will receive their own bind_now() calls.
         **
         *i  Scene Graph:
         **
         **    Scene graph renderers usually do not override this function.
         **
         *b  Callable From:
         **
         *-    - N/A (automatically called by DI-Guy Graphics API during
         *-      Draw Stage)
         */
        virtual void bind_now();

#endif


/****************************************************************************/
/****************************************************************************/

#ifdef CPLUSPLUS_ONLY

        bdiGeometryGeosetState* get_scripted_object() {return m_scripted_object;}

protected:

        /*l
         **    A protected constructor.  Constructors are called automatically
         **    by DI-Guy.
         */
        diguyGraphicsState(void* internal_data);

        /*l
         **    A protected destructor.  Destructors are called automatically
         **    by DI-Guy.
         */
        virtual ~diguyGraphicsState();

private:

        /*l
         **    A pointer to internal data.
         */
        bdiGeometryGeosetState* m_scripted_object;

        friend class bdiGeometryGeosetState;
        friend class bdiGeometryFactory;

#endif
};


#endif /* __diguyGraphicsState_H */