PluginFunctionsPolyLineCollection.hh 5.79 KB
Newer Older
Christopher Tenter's avatar
Christopher Tenter 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 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
/* ========================================================================= *
 *                                                                           *
 *                               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.              *
 *                                                                           *
 * ========================================================================= */

/*===========================================================================*\
 *
 *   $Revision$
 *   $Date$
 *
\*===========================================================================*/








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

/**
Jan Möbius's avatar
Jan Möbius committed
63 64
 * \file PluginFunctionsPolyLineCollection.hh
 * This file contains functions which can be used by plugins to access Polyline Collections in the framework.
Christopher Tenter's avatar
Christopher Tenter committed
65 66
 */

Jan Möbius's avatar
Jan Möbius committed
67
#pragma once
Christopher Tenter's avatar
Christopher Tenter committed
68 69 70 71 72 73 74 75 76

#include <OpenFlipper/common/Types.hh>
#include "PolyLineCollectionTypes.hh"
#include "PolyLineCollectionObject.hh"

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


Jan Möbius's avatar
Jan Möbius committed
77
/** \brief Get a pointer to every Polyline Collection which is marked as a source.
Christopher Tenter's avatar
Christopher Tenter committed
78
 *
Jan Möbius's avatar
Jan Möbius committed
79 80
 * @param _polylines ( vector returning the source Polyline Collections )
 * @return false, if no PolylineCollection is selected as source
Christopher Tenter's avatar
Christopher Tenter committed
81 82 83 84 85
*/

DLLEXPORT
bool getSourcePolylineCollections( std::vector<PolyLineCollection*>& _polylines  );

Jan Möbius's avatar
Jan Möbius committed
86
/** \brief Get a pointer to every Polyline Collection which is marked as a target.
Christopher Tenter's avatar
Christopher Tenter committed
87
 *
Jan Möbius's avatar
Jan Möbius committed
88 89
 * @param _polylines ( vector returning the target Polyline Collections )
 * @return false, if no PolylineCollection is selected as target
Christopher Tenter's avatar
Christopher Tenter committed
90 91 92 93 94 95
*/

DLLEXPORT
bool getTargetPolylineCollections( std::vector<PolyLineCollection*>& _polylines  );


Jan Möbius's avatar
Jan Möbius committed
96
/** This functions returns the object with the given id if it is a Polyline Collection.
Christopher Tenter's avatar
Christopher Tenter committed
97 98 99 100 101 102
 * See get_object(  int _identifier , BaseObject*& _object ) for more details.
 */

DLLEXPORT
bool getObject(  int _identifier , PolyLineCollectionObject*& _object );

Jan Möbius's avatar
Jan Möbius committed
103
/** \brief Get a polyLine Collection from an object.
Christopher Tenter's avatar
Christopher Tenter committed
104
 *
Jan Möbius's avatar
Jan Möbius committed
105 106
 * @param _object The object should be of type BaseDataObject. If the content is a Polyline Collection, a
 *                Polyline Collection will be returned. Otherwise a NULL pointer is returned.
Christopher Tenter's avatar
Christopher Tenter committed
107 108 109 110 111
 */

DLLEXPORT
PolyLineCollection* polyLineCollection( BaseObjectData* _object );

Jan Möbius's avatar
Jan Möbius committed
112
/** \brief Cast an BaseObject to a Polyline Collection Object if possible
Christopher Tenter's avatar
Christopher Tenter committed
113
 *
Jan Möbius's avatar
Jan Möbius committed
114 115
 * @param _object The object should be of type BaseDataObject. If the content is a Polyline Collection, a
 *                a Polyline Collection Object is returned. Otherwise a NULL pointer is returned.
Christopher Tenter's avatar
Christopher Tenter committed
116 117 118 119 120
 */

DLLEXPORT
PolyLineCollectionObject* polyLineCollectionObject( BaseObjectData* _object );

Jan Möbius's avatar
Jan Möbius committed
121
/** \brief Get an Polyline Collection Object from the given id If possible
Christopher Tenter's avatar
Christopher Tenter committed
122
*
Jan Möbius's avatar
Jan Möbius committed
123 124
* @param _objectId Id of the requested Object. If the content is a Polyline Collection,
*                  a Polyline Collection Object is returned. Otherwise a NULL pointer is returned.
Christopher Tenter's avatar
Christopher Tenter committed
125 126 127 128 129 130 131
*/

DLLEXPORT
PolyLineCollectionObject* polyLineCollectionObject( int _objectId );

}