/usr/include/sbml/packages/layout/sbml/CubicBezier.h is in libsbml5-dev 5.13.0+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 | /**
* @file CubicBezier.h
* @brief Definition of CubicBezier for SBML Layout.
* @author Ralph Gauges
*
* <!--------------------------------------------------------------------------
* This file is part of libSBML. Please visit http://sbml.org for more
* information about SBML, and the latest version of libSBML.
*
* Copyright (C) 2013-2016 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
* 3. University of Heidelberg, Heidelberg, Germany
*
* Copyright (C) 2009-2013 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*
* Copyright (C) 2004-2008 by European Media Laboratories Research gGmbH,
* Heidelberg, Germany
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation. A copy of the license agreement is provided
* in the file named "LICENSE.txt" included with this software distribution
* and also available online as http://sbml.org/software/libsbml/license.html
* ------------------------------------------------------------------------ -->
*
* @class CubicBezier
* @sbmlbrief{layout} A Cubic Bézier smooth curve.
*
* In order to be able to represent smooth curves the “layout”
* package defines the class CubicBezier. It represents a Bezier curve, and
* is readily available in most graphics APIs. The class CubicBezier is
* derived from LineSegment. It consists of four elements: the two inherited
* elements 'start' and 'end', which specify the starting point and the
* endpoint of the cubic bezier curve, and two elements 'basePoint1' and
* 'basePoint2', which specify the two additional base points that are needed
* to describe a cubic bezier curve.
*/
#ifndef CubicBezier_H__
#define CubicBezier_H__
#include <sbml/common/extern.h>
#include <sbml/common/sbmlfwd.h>
#include <sbml/packages/layout/common/layoutfwd.h>
#ifdef __cplusplus
#include <string>
#include <sbml/packages/layout/sbml/LineSegment.h>
#include <sbml/packages/layout/sbml/Point.h>
#include <sbml/packages/layout/extension/LayoutExtension.h>
LIBSBML_CPP_NAMESPACE_BEGIN
class LIBSBML_EXTERN CubicBezier : public LineSegment
{
protected:
/** @cond doxygenLibsbmlInternal */
Point mBasePoint1;
Point mBasePoint2;
bool mBasePt1ExplicitlySet;
bool mBasePt2ExplicitlySet;
/** @endcond */
public:
/**
* Creates a CubicBezier and returns the pointer.
*/
CubicBezier (unsigned int level = LayoutExtension::getDefaultLevel(),
unsigned int version = LayoutExtension::getDefaultVersion(),
unsigned int pkgVersion = LayoutExtension::getDefaultPackageVersion());
/**
* Ctor.
*/
CubicBezier (LayoutPkgNamespaces* layoutns);
/**
* Creates a CubicBezier with the given 2D coordinates and returns the
* pointer.
*
* (FOR BACKWARD COMPATIBILITY)
*
*/
CubicBezier (LayoutPkgNamespaces* layoutns, double x1, double y1, double x2, double y2);
/**
* Creates a CubicBezier with the given 3D coordinates and returns the
* pointer.
*
* (FOR BACKWARD COMPATIBILITY)
*
*/
CubicBezier (LayoutPkgNamespaces* layoutns, double x1, double y1, double z1,
double x2, double y2, double z2);
/**
* Copy constructor.
*
* (FOR BACKWARD COMPATIBILITY)
*
*/
CubicBezier(const CubicBezier& orig);
/**
* Creates a CubicBezier with the given points and returns the pointer.
*
* (FOR BACKWARD COMPATIBILITY)
*
*/
CubicBezier (LayoutPkgNamespaces* layoutns, const Point* start, const Point* end);
/**
* Creates a CubicBezier with the given points and returns the pointer.
*
* (FOR BACKWARD COMPATIBILITY)
*
*/
CubicBezier (LayoutPkgNamespaces* layoutns, const Point* start, const Point* base1,
const Point* base2, const Point* end);
/**
* Creates a new Layout from the given XMLNode
*
* (FOR BACKWARD COMPATIBILITY)
*
*/
CubicBezier(const XMLNode& node, unsigned int l2version=4);
/**
* Destructor.
*/
virtual ~CubicBezier ();
/**
* Assignment operator
*/
virtual CubicBezier& operator=(const CubicBezier& orig);
/**
* Returns a List of all child SBase objects, including those nested to an
* arbitrary depth
*
* @return a List* of pointers to all children objects.
*/
virtual List* getAllElements(ElementFilter* filter=NULL);
/**
* Returns the first base point of the curve (the one closer to the
* starting point).
*/
const Point* getBasePoint1 () const;
/**
* Returns the first base point of the curve (the one closer to the
* starting point).
*/
Point* getBasePoint1 ();
/**
* Initializes first base point with a copy of the given point.
*/
void setBasePoint1 (const Point* p);
/**
* Initializes first base point with the given coordinates.
*/
void setBasePoint1 (double x, double y, double z = 0.0);
/**
* Returns the second base point of the curve (the one closer to the end
* point).
*/
const Point* getBasePoint2 () const;
/**
* Returns the second base point of the curve (the one closer to the end
* point).
*/
Point* getBasePoint2 ();
/**
* Initializes second base point with a copy of the given point.
*/
void setBasePoint2 (const Point* p);
/**
* Initializes second base point with the given coordinates.
*/
void setBasePoint2 (double x, double y, double z = 0.0);
/** @cond doxygenLibsbmlInternal */
bool getBasePt1ExplicitlySet() const;
bool getBasePt2ExplicitlySet() const;
/** @endcond */
/**
* Calls initDefaults from LineSegment.
*/
void initDefaults ();
/**
* Makes a line from a CubicBezier by setting both base points into the
* middle between the start and the end point.
*/
void straighten ();
/** @cond doxygenLibsbmlInternal */
/**
* Subclasses should override this method to write out their contained
* SBML objects as XML elements. Be sure to call your parents
* implementation of this method as well. For example:
*
* SBase::writeElements(stream);
* mReactants.write(stream);
* mProducts.write(stream);
* ...
*/
virtual void writeElements (XMLOutputStream& stream) const;
/** @endcond */
/**
* Returns the XML element name of
* this SBML object.
*
* @return the string of the name of this element
*/
virtual const std::string& getElementName () const ;
/**
* Creates and returns a deep copy of this CubicBezier.
*
* @return a (deep) copy of this CubicBezier.
*/
virtual CubicBezier* clone () const;
/**
* Returns the libSBML type code of this object instance.
*
* @copydetails doc_what_are_typecodes
*
* @return the SBML type code for this object:
* @sbmlconstant{SBML_LAYOUT_CUBICBEZIER, SBMLLayoutTypeCode_t}
*
* @copydetails doc_warning_typecodes_not_unique
*
* @see getElementName()
* @see getPackageName()
*/
virtual int getTypeCode () const;
/** @cond doxygenLibsbmlInternal */
/**
* Accepts the given SBMLVisitor.
*
* @return the result of calling <code>v.visit()</code>, which indicates
* whether or not the Visitor would like to visit the SBML object's next
* sibling object (if available).
*/
virtual bool accept (SBMLVisitor& v) const;
/** @endcond */
/**
* Creates an XMLNode object from this.
*/
virtual XMLNode toXML() const;
/** @cond doxygenLibsbmlInternal */
/**
* Sets the parent SBMLDocument of this SBML object.
*
* @param d the SBMLDocument object to use
*/
virtual void setSBMLDocument (SBMLDocument* d);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Sets this SBML object to child SBML objects (if any).
* (Creates a child-parent relationship by the parent)
*
* Subclasses must override this function if they define
* one ore more child elements.
* Basically, this function needs to be called in
* constructor, copy constructor, assignment operator.
*
* @see setSBMLDocument
* @see enablePackageInternal
*/
virtual void connectToChild ();
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Enables/Disables the given package with this element and child
* elements (if any).
* (This is an internal implementation for enablePakcage function)
*
* @note Subclasses in which one or more child elements are defined
* must override this function.
*/
virtual void enablePackageInternal(const std::string& pkgURI,
const std::string& pkgPrefix, bool flag);
/** @endcond */
protected:
/** @cond doxygenLibsbmlInternal */
/**
* Create and return an SBML object of this class, if present.
*
* @return the SBML object corresponding to next XMLToken in the
* XMLInputStream or NULL if the token was not recognized.
*/
virtual SBase*
createObject (XMLInputStream& stream);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Subclasses should override this method to get the list of
* expected attributes.
* This function is invoked from corresponding readAttributes()
* function.
*/
virtual void addExpectedAttributes(ExpectedAttributes& attributes);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Subclasses should override this method to read values from the given
* XMLAttributes set into their specific fields. Be sure to call your
* parents implementation of this method as well.
*/
virtual void readAttributes (const XMLAttributes& attributes,
const ExpectedAttributes& expectedAttributes);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Subclasses should override this method to write their XML attributes
* to the XMLOutputStream. Be sure to call your parents implementation
* of this method as well. For example:
*
* SBase::writeAttributes(stream);
* stream.writeAttribute( "id" , mId );
* stream.writeAttribute( "name", mName );
* ...
*/
virtual void writeAttributes (XMLOutputStream& stream) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
*
* Subclasses should override this method to write their xmlns attriubutes
* (if any) to the XMLOutputStream.
*
*/
virtual void writeXMLNS (XMLOutputStream& stream) const;
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#ifndef SWIG
LIBSBML_CPP_NAMESPACE_BEGIN
BEGIN_C_DECLS
/**
* Creates a CubicBezier_t and returns the pointer.
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
CubicBezier_t *
CubicBezier_create ();
/**
* Creates a CubicBezier_t with the given points and returns the pointer.
*
* @param x1 The value of the x coordinate of the start Point_t.
* @param y1 The value of the y coordinate of the start Point_t.
* @param z1 The value of the z coordinate of the start Point_t.
* @param x2 The value of the x coordinate of the base1 Point_t.
* @param y2 The value of the y coordinate of the base1 Point_t.
* @param z2 The value of the z coordinate of the base1 Point_t.
* @param x3 The value of the x coordinate of the base2 Point_t.
* @param y3 The value of the y coordinate of the base2 Point_t.
* @param z3 The value of the z coordinate of the base2 Point_t.
* @param x4 The value of the x coordinate of the end Point_t.
* @param y4 The value of the y coordinate of the end Point_t.
* @param z4 The value of the z coordinate of the end Point_t.
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
CubicBezier_t *
CubicBezier_createWithCoordinates (double x1, double y1, double z1,
double x2, double y2, double z2,
double x3, double y3, double z3,
double x4, double y4, double z4);
/**
* Creates a CubicBezier_t with the given coordinates and returns the pointer.
*
* @param start The value of the 'start' Point_t
* @param base1 The value of the 'base1' Point_t
* @param base2 The value of the 'base2' Point_t
* @param end The value of the 'end' Point_t
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
CubicBezier_t *
CubicBezier_createWithPoints (const Point_t *start, const Point_t *base1,
const Point_t *base2, const Point_t *end);
/**
* Creates a CubicBezier_t structure from a template.
*
* @param temp The CubicBezier_t structure to copy.
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
CubicBezier_t *
CubicBezier_createFrom (const CubicBezier_t *temp);
/**
* Frees the memory for the cubic bezier.
*
* @param cb The CubicBezier_t structure.
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
void
CubicBezier_free (CubicBezier_t *cb);
/**
* Initializes start point with a copy of the given point.
*
* @param cb The CubicBezier_t structure.
* @param point The Point_t structure to use as the start point.
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
void
CubicBezier_setStart (CubicBezier_t *cb, const Point_t *point);
/**
* Initializes end point with a copy of the given point.
*
* @param cb The CubicBezier_t structure.
* @param point The Point_t structure to use as the end point.
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
void
CubicBezier_setEnd (CubicBezier_t *cb, const Point_t *point);
/**
* Initializes the first base point with a copy of the given point.
*
* @param cb The CubicBezier_t structure.
* @param point The Point_t structure to use as the base1 point.
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
void
CubicBezier_setBasePoint1 (CubicBezier_t *cb, const Point_t *point);
/**
* Initializes second base point with a copy of the given point.
*
* @param cb The CubicBezier_t structure.
* @param point The Point_t structure to use as the base2 point.
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
void
CubicBezier_setBasePoint2 (CubicBezier_t *cb, const Point_t *point);
/**
* Returns the starting point of the curve.
*
* @param cb The CubicBezier_t structure.
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
Point_t *
CubicBezier_getStart (CubicBezier_t *cb);
/**
* Returns the endpoint of the curve.
*
* @param cb The CubicBezier_t structure.
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
Point_t *
CubicBezier_getEnd (CubicBezier_t *cb);
/**
* Returns the first base point of the curve (the one closer to the
* starting point).
*
* @param cb The CubicBezier_t structure.
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
Point_t *
CubicBezier_getBasePoint1 (CubicBezier_t *cb);
/**
* Returns the second base point of the curve (the one closer to the end
* point).
*
* @param cb The CubicBezier_t structure.
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
Point_t *
CubicBezier_getBasePoint2 (CubicBezier_t *cb);
/**
* Calls initDefaults from LineSegment.
*
* @param cb The CubicBezier_t structure.
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
void
CubicBezier_initDefaults (CubicBezier_t *cb);
/**
* @return a (deep) copy of this CubicBezier_t.
*
* @param cb The CubicBezier_t structure.
*
* @memberof CubicBezier_t
*/
LIBSBML_EXTERN
CubicBezier_t *
CubicBezier_clone (const CubicBezier_t *cb);
END_C_DECLS
LIBSBML_CPP_NAMESPACE_END
#endif /* !SWIG */
#endif /* CubicBezier_H__ */
|