PluginFunctionsPlane.hh 5.05 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
*                                                                            *
\*===========================================================================*/

Jan Möbius's avatar
Jan Möbius committed
42

Jan Möbius's avatar
Jan Möbius committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60


//=============================================================================
//
//  Standard Functions
//
//=============================================================================

/**
 * \file PluginFunctionsPlane.hh
 * This file contains functions which can be used by plugins to access planes in the framework.
 */

//
#ifndef PLUGINFUNCTIONSPLANE_HH
#define PLUGINFUNCTIONSPLANE_HH

#include <OpenFlipper/common/Types.hh>
61
#include <OpenFlipper/common/ObjectTypeDLLDefines.hh>
Jan Möbius's avatar
Jan Möbius committed
62 63 64 65 66 67 68

/** The Namespace PluginFunctions contains functions for all plugins. */
namespace PluginFunctions {

/** This functions returns the object with the given id if it is a PlaneObject.
 * See get_object(  int _identifier , BaseObject*& _object ) for more details.
 */
69
OBJECTTYPEDLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
70 71 72 73 74 75 76
bool getObject(  int _identifier , PlaneObject*& _object );

/** \brief Get a PlaneNode from an object.
 *
 * @param _object The object should be of type BaseDataObject. If the content is a plane, a
 *                PlaneNode will be returned. Otherwise a NULL pointer is returned.
 */
77
OBJECTTYPEDLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
78 79 80 81 82 83 84
PlaneNode* planeNode( BaseObjectData* _object );

/** \brief Get a Plane from an object.
 *
 * @param _object The object should be of type BaseDataObject. If the content is a plane, a
 *                Plane will be returned. Otherwise a NULL pointer is returned.
 */
85
OBJECTTYPEDLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
86 87 88 89 90 91 92
Plane* plane( BaseObjectData* _object );

/** \brief Cast an BaseObject to a PlaneObject if possible
 *
 * @param _object The object should be of type BaseDataObject. If the content is a plane, a
 *                a PlaneObject is returned. Otherwise a NULL pointer is returned.
 */
93
OBJECTTYPEDLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
94 95 96 97 98 99
PlaneObject* planeObject( BaseObjectData* _object );

/** \brief Get a PlaneObject from an object id if possible
*
* @param _objectId If the object is a plane, a PlaneObject is returned. Otherwise a NULL pointer is returned.
*/
100
OBJECTTYPEDLLEXPORT
Jan Möbius's avatar
Jan Möbius committed
101 102 103 104 105
PlaneObject* planeObject( int _objectId );

}

#endif // PLUGINFUNCTIONSPLANE_HH