diguyGraphicsMaterial.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 1992-2015 VT MAK
 ** All rights reserved. 
 *********************************************************************/

/*********************************************************************/
#ifndef __diguyGraphicsMaterial_H
#define __diguyGraphicsMaterial_H

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

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

class bdiGeometryMtl;
class diguyGraphicsMaterial;

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

#endif

/****************************************************************************/
class BDI_DECLSPEC_diguy diguyGraphicsMaterial
{

public:

/*****************************************************************************/
        /*l
         *b  Description:
         **
         **    Returns the name of the texture.  This pointer will
         **    never be NULL.
         **
         *b  Returns:
         **
         **    name of the texture
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* get_name();

#ifdef CPLUSPLUS_ONLY

        /*l
         *b  Description:
         **
         **    This function returns the red, green, blue, and alpha
         **    components of the material's ambient setting.  All returned
         **    values will be between 0 (least intensity) and 1 (highest
         **    intensity).
         **
         *b  Arguments:
         **
         *a    rgba - pointer to an array of four floats into which results
         *a           should be copied
         **
         *b  Callable From:
         **
         *-    - C++
         */
        void get_ambient(float* rgba);

        /*l
         *b  Description:
         **
         **    This function returns the red, green, blue, and alpha
         **    components of the material's diffuse setting.  All returned
         **    values will be between 0 (least intensity) and 1 (highest
         **    intensity).
         **
         *b  Arguments:
         **
         *a    rgba - pointer to an array of four floats into which results
         *a           should be copied
         **
         *b  Callable From:
         **
         *-    - C++
         */
        void get_diffuse(float* rgba);

        /*l
         *b  Description:
         **
         **    This function returns the red, green, blue, and alpha
         **    components of the material's specular setting.  All returned
         **    values will be between 0 (least intensity) and 1 (highest
         **    intensity).
         **
         *b  Arguments:
         **
         *a    rgba - pointer to an array of four floats into which results
         *a           should be copied
         **
         *b  Callable From:
         **
         *-    - C++
         */
        void get_specular(float* rgba);

        /*l
         *b  Description:
         **
         **    This function returns the red, green, blue, and alpha
         **    components of the material's emission setting.  All returned
         **    values will be between 0 (least intensity) and 1 (highest
         **    intensity).
         **
         *b  Arguments:
         **
         *a    rgba - pointer to an array of four floats into which results
         *a           should be copied
         **
         *b  Callable From:
         **
         *-    - C++
         */
        void get_emission(float* rgba);

        /*l
         *b  Description:
         **
         **    This function returns the material's shininess setting.
         **
         *b  Arguments:
         **
         *a    s - pointer to float into which result should be copied
         **
         *b  Callable From:
         **
         *-    - C++
         */
        void get_shininess(float* s);

        
        /*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();

#endif

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

        /*l
         *b  Description:
         **
         **    This function returns the last material that was bound.
         **
         **    In bind_now() the current material can be checked against the last
         **    bound material; if the values are the same the bind_now() function
         **    can most often immediately return.  This is desirable because
         **    rendering state changes can have significant performance overhead.
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        static diguyGraphicsMaterial* get_last_bound_material();

        /*l
         *b  Description:
         **
         **    This function clears out the last bound material pointer.
         **
         **    diguyScenario::draw() calls it automatically, but it's recommended
         **    that this function also be called when the drawing of a new
         **    character is beginning.  This can be done in
         **    diguyGraphicsLink::begin_character_draw().
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        static void clear_last_bound_material();



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

        /*l
         *b  Description:
         **
         **    This function will be called by DI-Guy when it is time for a
         **    renderer-specific material object to be created.  At that point
         **    all material information has been read and is available via the
         **    Accessor Functions above.
         **
         *i  Immediate Mode:
         **
         **    Immediate mode renderers may override this function, to
         **    create an object that may be invoked by bind_now() to set
         **    material attributes.
         **
         *i  Scene Graph:
         **
         **    Scene graph renderers usually do override this function, to
         **    create a material object that will be associated with
         **    diguyGraphicsMesh 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 material 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 usually do 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 material should
         **    be made active, or bound.
         **
         **    Note that this material should be checked against the material
         **    returned by get_last_bound_material().  If they're the same this
         **    function should return early.
         **
         *i  Immediate Mode:
         **
         **    Immediate mode renderers usually do override this function, to
         **    invoke the object created by build(), or make calls to the
         **    renderer to set appropriate material state.
         **
         *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

        bdiGeometryMtl* get_scripted_object() {return m_scripted_object;}

protected:

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

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

private:

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

        friend class bdiGeometryMtl;
        friend class bdiGeometryFactory;

#endif
};


#endif /* __diguyGraphicsMaterial_H */