ged.h

Go to the documentation of this file.

/*                           G E D . H
 * BRL-CAD
 *
 * Copyright (c) 2008-2025 United States Government as represented by
 * the U.S. Army Research Laboratory.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this file; see the file named COPYING for more
 * information.
 */
/** @addtogroup libged
 *
 * Functions provided by the LIBGED geometry editing library.  These routines
 * are a procedural basis for the geometric editing capabilities available in
 * BRL-CAD.  The library is tightly coupled to the LIBRT library for geometric
 * representation and analysis.  The libdm API is assumed for commands that
 * manipulate geometric views.
 *
 * A note to C/C++ developers - calling libged's commands programmatically has
 * a disadvantage compared to calling lower level routines in that input values
 * must pass through string processing.  In addition to the overhead induced,
 * this decoupling prevents the compiler from performing a wide variety of
 * checks and optimizations.  Generally speaking, if you're writing C/C++ code
 * and are having to construct argc/argv inputs to call a libged function,
 * you'll want to consider calling lower level routines instead to allow the
 * compiler to have more insight into what the code is doing.
 *
 * If the above isn't possible because the core functionality of the command
 * is implemented only in libged with no lower level interface available, that
 * logic is probably a candidate for refactoring.
 */
/** @{ */
/** @file ged.h */
 
#ifndef GED_H
#define GED_H
 
#include "common.h"
 
#include "bv/defines.h"
#include "raytrace.h"
#include "analyze.h"
#include "ged/defines.h"
#include "ged/version.h"
#include "ged/database.h"
#include "ged/commands.h"
#include "ged/objects.h"
#include "ged/view.h"
#include "ged/debug.h"
 
// At least for the moment these wrappers are not public API - include them
// only for the BRL-CAD build itself.
#ifdef BRLCADBUILD
#include "ged/ged_cmds.h"
#endif
 
/** @} */
 
__BEGIN_DECLS
 
/** @addtogroup ged_misc */
/** @{ */
 
/**
 * Delay the specified amount of time
 */
GED_EXPORT extern int ged_delay(struct ged *gedp, int argc, const char *argv[]);
 
/**
 * Echo the specified arguments.
 */
GED_EXPORT extern int ged_echo(struct ged *gedp, int argc, const char *argv[]);
 
/**
 * Echo the specified arguments.
 */
GED_EXPORT extern int ged_help(struct ged *gedp, int argc, const char *argv[]);
 
/** @} */
 
/** @addtogroup libged */
/** @{ */
/***************************************
 * Conceptual Documentation for LIBGED *
 ***************************************
 *
 * Below are developer notes for a data structure layout that this
 * library is being migrated towards.  This is not necessarily the
 * current status of the library, but rather a high-level concept for
 * how the data might be organized down the road for the core data
 * structures available for application and extension management.
 *
 * struct ged {
 *   dbip
 *   views * >-----.
 *   result()      |
 * }               |
 *                 |
 * struct view { <-'
 *   geometry * >------.
 *   update()          |
 * }                   |
 *                     |
 * struct geometry { <-'
 *   display lists
 *   directory *
 *   update()
 * }
 *
 */
 
__END_DECLS
 
#endif /* GED_H */
 
/** @} */
 
/*
 * Local Variables:
 * tab-width: 8
 * mode: C
 * indent-tabs-mode: t
 * c-file-style: "stroustrup"
 * End:
 * ex: shiftwidth=4 tabstop=8
 */