diguyGraphicsInstanceGroup.h

Go to the documentation of this file.

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

/*********************************************************************/
#ifndef __diguyGraphicsInstanceGroup_H
#define __diguyGraphicsInstanceGroup_H

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

#ifdef CPLUSPLUS_ONLY
#include <diguy_constants.h>

class bdiInstanceGroup;
class diguyGraphicsInstanceGroup;
class diguyGraphicsShaderProgram;
class diguyGraphicsShape;
class diguyGraphicsMesh;

#endif

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

#include <declspec_diguy.h>

class BDI_DECLSPEC_diguy diguyGraphicsInstanceGroup
{
public:

/*****************************************************************************/
        /*l
         *b  Description:
         **
         **    Instance groups are assigned a unique identifier, or uid.  This
         **    function returns the uid of the instance group.
         **
         **    *Note*: uid will change between DI Guy runs.
         **
         *b  Returns:
         **    uid of the instance group
         **
         */
        long get_uid() const;

        /*l
         *b  Description:
         **
         **    Returns the number of instances in the instance group.
         */
        int get_num_instances() const;

        /*l
         *b  Description:
         **
         **    Return the offset, in floats, of the base data for the instance group.
         **
         *b  Returns:
         **
         **    offset, in bytes, of the instance group in the buffer data
         */
        int get_start_base_offset() const;

        /*l
         *b  Description:
         **
         **    Return the offset, in floats, of the link data for the instance group.
         **
         *b  Returns:
         **
         **    offset, in bytes, of the instance group in the buffer data
         */
        int get_start_link_offset() const;

        /*l
         *b  Description:
         **
         **    Returns the number of links for instances with skinned geometry.
         **
         **    *Note*: will return 0 if the geometry is not skinned
         **
         *b  Returns:
         **
         **    number of links
         */
        int get_num_links() const;

        /*l
         *b  Description:
         **
         **    Returns the debug color of an instance group.
         **
         *b  Returns:
         **
         **    RGBA color
         */
        void get_debug_color(float& r, float& g, float& b, float& a) const;
        
        int get_show_debug_colors() const;

        /*l
         *b  Description:
         **
         **    This function returns a pointer to the shader program designated
         **    for this instance group. if any.  Shader programs are shared objects
         **    usable meshes and instance groups.
         **    by many meshes.
         **
         *b  Returns:
         **
         **    pointer to diguyGraphicsShaderProgram, or NULL if this instance
         **    group does not have a shader specified
         */
        diguyGraphicsShaderProgram* get_shader_program() const;

        /*l
         *b  Description:
         **
         **    Returns a pointer to the low level geometry mesh object that comprises
         **    the renderable for the instances in the group.
         **
         *b  Returns:
         **
         **    pointer of type diguyGraphicsMesh
         */
        diguyGraphicsMesh* get_diguy_mesh();
        
        /*l
         *b  Description:
         **
         **    Returns a index to which swapped texture state to use for drawing this instance group. Only 
         **    meaningful if respect texture states is on.
         */
        int get_graphics_state_switch_index();

        /*l
         *b  Description:
         **
         **    Returns a pointer to the raw instance data for the instance group.
         **
         *b  Returns:
         **
         **    pointer to the instance data
         */
        const float* get_instance_data();

        /*l
         *b  Description:
         **
         **    Return the size of the data for the instance group in bytes.
         **
         *b  Returns:
         **
         **    size, in bytes, of the instance buffer data
         */
        int get_instance_data_size();

        /*l
         *b  Description:
         **
         **    Returns a pointer to the raw instance data for the instance group.
         */
        const float* get_instance_base_data();

        /*l
         *b  Description:
         **
         **    Return the size of the data for the instance group in bytes.
         */
        int get_instance_base_data_size();

        /*l
         *b  Description:
         **
         **    Returns a pointer to the raw instance data for the instance group.
         */
        const float* get_instance_link_data();

        /*l
         *b  Description:
         **
         **    Return the size of the data for the instance group in bytes.
         */
        int get_instance_link_data_size();

        /*l
         *b  Description:
         **
         **    Return the size of the data for all instance groups in bytes.
         */
        int get_instance_data_all_groups_size();

        
        /*l
         *b  Description:
         **
         **    Return the number of extra floats the user has requested for the tbo, must be multiple of 4.
         */
        int get_num_extra_per_instance_data_floats();

#ifdef CPLUSPLUS_ONLY

        /*l
         *b  Description:
         **
         **    This function will be called by DI-Guy when it is time for a
         **    renderer specific instance group to be created. All information
         **    to construct the instance group for consumption by either an
         **    immediate mode or scene graph renderer is avaiable via the
         **    Accessor Functions above when this function is called.
         **
         *i  Immediate Mode:
         **
         **    Immediate mode renderers do not usually override this function.
         **
         *i  Scene Graph:
         **
         **    Scene graph renderers override this function to create scene graph
         **    specific objects to handle mangement and rendering of the instance
         **    group.
         **
         *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
         **    instance group 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 it is time for
         **    the instance group to be updated with new data.
         **
         *i  Immediate Mode:
         **
         **    Immediate mode renderers usually do not override this function.
         **
         *i  Scene Graph:
         **
         **    Scene graph renderers should override this function if they are
         **    supporting instancing.
         **
         *b  Callable From:
         **
         *-    - N/A (automatically called by DI-Guy Graphics API during
         *-      Update Stage)
         */
        virtual void update();

        /*l
         *b  Description:
         **
         **    This function will be called by DI-Guy when variables for
         **    using the instance data needs to be sent to the graphics card.
         **
         **    For GLSL-based shaders, these values are typically passed into
         **    the vertex shader via uniform variables.
         **
         *i  Immediate Mode:
         **
         **    Immediate mode renderers usually do override this function.
         **
         *i  Scene Graph:
         **
         **    Scene graph renderers usually do not override this function,
         **    but instead use diguyGraphicsShape::get_shader_matrix_data() during the Update Stage.
         **
         *b  Callable From:
         **
         *-    - N/A (automatically called by DI-Guy Graphics API during
         *-      the Draw Stage)
         */
        virtual int bind_instance_group_data(int base_start, int link_start, int count);

        /*l
         *b  Description:
         **
         **    This function will be called by DI-Guy when data for instance
         **    groups needs to be sent to the graphics card.
         **
         *i  Immediate Mode:
         **
         **    Immediate mode renderers usually do override this function.
         **
         *i  Scene Graph:
         **
         **    Scene graph renderers usually do not override this function,
         **    but instead update the instance data in diguyGraphicsInstanceGroup::update()
         **
         *b  Callable From:
         **
         *-    - N/A (automatically called by DI-Guy Graphics API during
         *-      the Draw Stage)
         */
        virtual int bind_instance_buffer_data(int num_floats, const float* instance_data);

#endif

        diguyGraphicsShape * get_instanced_shape_at_index(int index);

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

#ifdef CPLUSPLUS_ONLY
        bdiInstanceGroup* get_scripted_object() { return m_scripted_object; }

protected:

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

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

private:

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

        friend class bdiInstanceGroup;
        friend class bdiGraphicsFactory;
#endif

};

#endif //__diguyGraphicsInstanceGroup_H