diguySceneObject.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 1992-2022 MAK Technologies, Inc.
 ** All rights reserved. 
 *********************************************************************/

/*********************************************************************
 **
 *t  diguySceneObject
 **
 *b    Link against: libdiguy
 */

#ifndef __diguySceneObject_H
#define __diguySceneObject_H

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

#ifdef CPLUSPLUS_ONLY
class bdiScenarioSceneObject;
#endif

#include <declspec_diguy.h>
#include <diguy_constants.h>
#include <stdio.h> // for NULL

class diguyGraphicsShaderInstance;
class diguyGraphicsShaderProgram;
class diguyGraphicsShaderTechnique;

/****************************************************************************/
class BDI_DECLSPEC_diguy diguySceneObject
{

/*****************************************************************************/
public:

        /*l
         *b  Description:
         **
         **    Returns the name of the scene object.  This pointer will
         **    never be NULL.
         **
         *b  Returns:
         **
         **    name of the scene object
         */
        const char* get_name();

        /*l
         *b  Description:
         **
         **    This function sets the name of this object.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int set_name(const char* name);

        /*l
         *b  Description:
         **
         **    All scene objects are assigned a unique identifier, or uid.  This
         **    function returns this scene object's uid.
         **
         **    *Note*: unique identifiers will change between DI-Guy runs!
         **
         *b  Returns:
         **
         **    unique identifier of object
         */
        long get_uid();

        /*l
         *b  Description:
         **
         **    Returns the filename of the scene object.  This pointer will
         **    never be NULL.
         **
         **    The returned filename may be relative to another directory,
         **    such as $DIGUY/geometry/sets.  Call get_fully_resolved_filename()
         **    to have DI-Guy search for the fully resolved filename.
         **
         *b  Returns:
         **
         **    filename of the scene object
         */
        const char* get_filename();

        /*l
         *b  Returns:
         **
         **    node within the scene object file; returned string is 0 length if
         **    contents of entire file should be used
         */
        const char* get_nodename();

        /*l
         *b  Returns:
         **
         **    alternate filename of the scene object
         */
        const char* get_alternate_filename();

        /*l
         *b  Description:
         **
         **    Returns the fully resolved filename of the scene object.  Returns
         **    NULL if the file cannot be found.
         **
         *b  Returns:
         **
         **    fully resolved filename of the scene object; NULL if not found
         */
        const char* get_fully_resolved_filename();

        /*l
         *b  Description:
         **
         **    Attempts to load the file returned by get_filename() and
         **    construct an object that can be rendered in the current
         **    graphics environment by the call draw_visual().
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         */
        int show();

        /*l
         *b  Description:
         **
         **    Hides the scene object.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int hide();

        /*l
         *b  Description:
         **
         **    Adds a vertex to a user defined scene object.
         **
         *b Returns:
         **
         **     0 on success, -1 on failure
         */
        int add_vertex_to_user_defined(float x, float y, float z);

        /*l
         *b  Description:
         **
         **    Adds a triangle to a user defined scene object.
         **    Indices refer to vertices added with a add_vertex_* call.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int add_triangle_to_user_defined(int index0, int index1, int index2);

#ifdef CPLUSPLUS_ONLY
        /*l
         *b  Description:
         **
         **    Adds an array of vertices to a user defined scene object.
         **
         *b  Arguments:
         **
         *a    skipBytes - bytes between vertex position information
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int add_vertex_array_to_user_defined(const float* const vertices, 
                int num_vertices, int skipBytes = 12);

        /*l
         *b  Description:
         **
         **    Adds an array of triangles to a user defined scene object.
         **    The array should contain indices to vertices added with add_vertex_* calls.
         **
         *b  Arguments:
         **
         *a    num_indices - Number of indices (3 indices per triangle).
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int add_triangle_array_to_user_defined(const int* const indices, int num_indices);

        /*l
         *b  Description:
         **
         **    Adds a triangle to a user defined object.
         **    Positions are expected to be float[3].
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int add_triangle_to_user_defined(const float* const pos0,
                const float* const pos1, const float* const pos2);
#endif

        /*l
         *b  Description:
         **
         **    Builds the geometry of the user defined scene object
         **    from data passed via add_vertex_* and add_triangle_* calls.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int build_user_defined();


/*****************************************************************************/
        /*l
         *b  Description:
         **
         **    This function is essentially the same as the function
         **    diguyCharacter::set_render_mode_shader(), but applies to this
         **    scene object.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int set_render_mode_shader(const char* shader_name,
                const char* render_mode = NULL);

        /*l
         *b  Description:
         **
         **    This function is essentially the same as the function
         **    diguyCharacter::reset_render_mode_shader_to_default(), but
         **    applies to this scene object.
         */
        void reset_render_mode_shader_to_default(const char* render_mode = NULL);

        /*l
         *b  Description:
         **
         **    This function is essentially the same as the function
         **    diguyCharacter::get_render_mode_shader(), but applies to this to
         **    this scene object.
         **
         *b  Returns:
         **
         **    name of shader program; NULL if none
         */
        const char* get_render_mode_shader(const char* render_mode = NULL);

        /*l
         *b  Description:
         **
         **    This function is essentially the same as the function
         **    diguyCharacter::get_shader_program(), but applies to this to
         **    this scene object. It's here for backwards compatibility DI-Guy 12
         **    now uses shader techniques as wrappers for shader programs.
         **
         *b  Returns:
         **
         **    object of type diguyGraphicsShaderProgram; NULL if none
         */
        diguyGraphicsShaderProgram* get_shader_program();

        /*l
         *b  Description:
         **
         **    This function is essentially the same as the function
         **    diguyCharacter::get_shader_technique(), but applies to this to
         **    this scene object.
         **
         *b  Returns:
         **
         **    object of type diguyGraphicsShaderTechnique; NULL if none
         */
        diguyGraphicsShaderTechnique* get_shader_technique();

        /*l
         *b  Description:
         **
         **    This function is essentially the same as the function
         **    diguyCharacter::set_temporary_current_shader_program(), but
         **    applies to this to this scene object.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         */
        int set_temporary_current_shader(const char* shader_name);

        /*l
         *b  Description:
         **
         **    This function is essentially the same as the function
         **    diguyCharacter::reset_current_shader_to_default(), but
         **    applies to this to this scene object.
         */
        void reset_current_shader_to_default();

        /*l
         *b  Description:
         **
         **    This function is essentially the same as the function
         **    diguyCharacter::get_shader_instance(), but applies to this to
         **    this scene object.
         **
         **    Note that the shader instance of a scene object can change over
         **    the lifetime of the scene object.  Therefore the returned pointer
         **    should not be stored, but should be re-read each time it is
         **    needed.
         **
         *b  Returns:
         **
         **    object of type diguyGraphicsShaderInstance; NULL if none
         */
        diguyGraphicsShaderInstance* get_shader_instance();

        /*l
         *b  Description:
         **
         **    This function is essentially the same as the function
         **    diguyCharacter::reset_shader_instance_variables_to_initial_values(),
         **    but applies to this scene object.
         */
        void reset_shader_instance_variables_to_initial_values();

        /*l
         *b  Description:
         **
         **    This function is essentially the same as the function
         **    diguyCharacter::reset_shader_instance_variables_to_program_defaults(),
         **    but applies to this scene object.
         */
        void reset_shader_instance_variables_to_program_defaults();


        /*l
         **    Deprecated as of 10.5.2.  Use set_shader_program_name() instead.
         */
        int set_shader_program(const char* shader_name);


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

        int set_position(float x, float y, float z);
        int get_position(float* x, float* y, float* z);

        int set_orientation(float rz, float rx, float ry);
        int get_orientation(float* rz, float* rx, float* ry);

        int set_scale(float sx, float sy, float sz);
        int get_scale(float* sx, float* sy, float* sz);

        int set_filename(const char* file_name);
        int get_is_sky_box();
        int set_is_sky_box(int skybox);

        /*l
         *    should be a member of diguyGraphicsTextureLoadingBehavior
         *    DIGUY_LOAD_INSTANTLY, DIGUY_LOAD_PRIORITY_ASYNC, DIGUY_LOAD_ASYNC
         */
        static int set_texture_load_behavior(diguyGraphicsTextureLoadingBehavior mode);
        static diguyGraphicsTextureLoadingBehavior get_texture_load_behavior();


#ifdef CPLUSPLUS_ONLY

        /*l
         *b  Description:
         **
         **    Draws the scene object.
         **
         *i    Currently OpenGL only.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         */
        int draw_visual();

#endif

        int get_include_in_octtree();
        int set_include_in_octtree(int val);

        int set_include_in_physics_sim_scene(int include_in_simulation_terrain);
        int get_include_in_physics_sim_scene();

        int set_physics_collision_group(diguyPhysicsCollisionGroup collision_group);
        diguyPhysicsCollisionGroup get_physics_collision_group();

        int get_min(float* x, float* y, float* z);
        int get_max(float* x, float* y, float* z);

        /*
         *  DI-Guy doesn't use these masks internally, but they can be useful
         *   for some DI-Guy Graphics API scene graph implementations.
         */
        void set_scene_graph_mask(unsigned int mask);
        unsigned int get_scene_graph_mask();

        int get_enabled();
        int set_enabled(int enabled);

        int get_visible();
        int set_visible(int visible);

#ifdef CPLUSPLUS_ONLY

public:

        bdiScenarioSceneObject* get_scripted_object() {return m_scripted_object;}



private:

        /*l
         **    A private constructor.
         */
        diguySceneObject(bdiScenarioSceneObject* scene_object);

        /*l
         **    A private destructor.
         */
        ~diguySceneObject();

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

        friend class bdiScenarioSceneObject;

#endif

};

#endif /* __diguySceneObject_H */