diguyGraphicsFile

Generated from diguyGraphicsFile.h

DI-Guy API Version 12.5.1

This file was automatically generated from diguyGraphicsFile.h. Do not edit this file directly; the changes will be lost.

Includes: diguy_constants.h | declspec_diguy.h

Contents:

Alphabetical Index

Link against: libdiguy

class diguyGraphicsFile

class BDI_DECLSPEC_diguy diguyGraphicsFile
{
public:
    const char* get_filename();
#ifdef CPLUSPLUS_ONLY
    virtual int load(const char* filename, const char* extension);
    virtual int unload();
    virtual void* find_part(const char* part_name);
#endif

Accessor Functions

The functions in this section provide access to data in this object. They are designed to be called directly by DI-Guy programmers when needed.

function diguyGraphicsFile::get_filename

Prototype:
const char* get_filename();
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.
Returns:

filename of the graphics file
Callable From:

C++
Script

Virtual Functions

The functions in this section are all virtual functions that will be called by DI-Guy at various times during DI-Guy execution.

Because the functions are all virtual, DI-Guy programmers can create a subclass of this class and override them. Unless otherwise stated, the base class functions do not need to be called.

function diguyGraphicsFile::load

Prototype:
virtual int load(const char* filename, const char* extension);
Description:

This function is called when the contents of a geometry file need to be loaded.
DI-Guy Loader:

Implementations using the DI-Guy Loader usually do not override this function.
External Loader:

Implementations using an External Loader must override this function.
Arguments:

filename the name of the geometry file that needs to be loaded
extension the extension (usually 3 characters) of the file; can help quickly choose an appropriate external loader

The filename argument includes the full path to the file to be loaded.
Callable From:

N/A (automatically called by DI-Guy Graphics API during the Build Stage)

function diguyGraphicsFile::unload

Prototype:
virtual int unload();
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.
DI-Guy Loader:

Implementations using the DI-Guy Loader usually do not override this function.
External Loader:

Implementations using an External Loader must override this function.
Callable From:

N/A (automatically called by DI-Guy Graphics API during the Unbuild Stage)

function diguyGraphicsFile::find_part

Prototype:
virtual void* find_part(const char* part_name);
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.
Arguments:

part_name the name of the part that needs to be found
DI-Guy Loader:

Implementations using the DI-Guy Loader usually do not override this function.
External Loader:

Implementations using an External Loader must override this function.
Callable From:

N/A (automatically called by DI-Guy Graphics API during the Build Stage)

Alphabetical Index

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 Sofware 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.

`filename`	the name of the geometry file that needs to be loaded
`extension`	the extension (usually 3 characters) of the file; can help quickly choose an appropriate external loader