diguyGraphicsFile.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 __diguyGraphicsFile_H
#define __diguyGraphicsFile_H

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

#ifdef CPLUSPLUS_ONLY
#include <diguy_constants.h>

class diguyGraphicsFile;
class bdiGeometryFile;

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

#endif

#include <declspec_diguy.h>

/****************************************************************************/
class BDI_DECLSPEC_diguy diguyGraphicsFile
{

public:

/*****************************************************************************/
        /*l
         *b  Description:
         **
         **    Returns the filename of the graphics file.  This is the filename
         **    that was passed to load().  The filename may be NULL if load() has
         **    not been called.
         **
         *b  Returns:
         **
         **    filename of the graphics file
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* get_filename();


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

        /*l
         *b  Description:
         **
         **    This function is called when the contents of a geometry file need
         **    to be loaded.
         **
         *i  DI-Guy Loader:
         **
         **    Implementations using the DI-Guy Loader usually do not override
         **    this function.
         **
         *i  External Loader:
         **
         **    Implementations using an External Loader must override this
         **    function.
         **
         *b  Arguments:
         **
         *a    filename    - the name of the geometry file that needs to
         *a                  be loaded
         *a    extension   - the extension (usually 3 characters) of the file;
         *a                  can help quickly choose an appropriate external
         *a                  loader
         **
         **    The filename argument includes the full path to the file to
         **    be loaded.
         **
         *b  Callable From:
         **
         *-    - N/A (automatically called by DI-Guy Graphics API during
         *-      the Build Stage)
         */
        virtual int load(const char* filename, const char* extension);

        /*l
         *b  Description:
         **
         **    This function does anything necessary to unload assets created
         **    during the load() call.  It will be called after all meshes,
         **    states, etc., that were extracted from the file have been
         **    unloaded.
         **
         *i  DI-Guy Loader:
         **
         **    Implementations using the DI-Guy Loader usually do not override
         **    this function.
         **
         *i  External Loader:
         **
         **    Implementations using an External Loader must override this
         **    function.
         **
         *b  Callable From:
         **
         *-    - N/A (automatically called by DI-Guy Graphics API during
         *-      the Unbuild Stage)
         */
        virtual int unload();

        /*l
         *b  Description:
         **
         **    This function needs to find and return an object representing a
         **    shape in the data loaded during the load() call.  Typically this
         **    is a group-type node above the meshes containing the geometry of
         **    the shape.
         **
         **    The returned object is not used directly by DI-Guy.  Instead, it
         **    will be used in later calls to
         **    diguyGraphicsShape::get_diguy_graphics_file_part(), during the
         **    Build Stage.
         **
         *b  Arguments:
         **
         *a    part_name - the name of the part that needs to be found
         **
         *i  DI-Guy Loader:
         **
         **    Implementations using the DI-Guy Loader usually do not override
         **    this function.
         **
         *i  External Loader:
         **
         **    Implementations using an External Loader must override this
         **    function.
         **
         *b  Callable From:
         **
         *-    - N/A (automatically called by DI-Guy Graphics API during
         *-      the Build Stage)
         */
        virtual void* find_part(const char* part_name);

#endif


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

#ifdef CPLUSPLUS_ONLY

        bdiGeometryFile* get_scripted_object() {return m_scripted_object;}

protected:

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

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

private:

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

        friend class bdiGeometryFactory;
        friend class bdiGeometryFile;

#endif

};


#endif /* __diguyGraphicsFile_H */