• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • kdeedu
  • Sitemap
  • Contact Us
 

kig

KigDocument Class Reference

#include <kig_document.h>

List of all members.


Detailed Description

KigDocument is the class holding the real data in a Kig document.

It owns a set of Objects, and a CoordinateSystem, which comprise the entire content of a Kig document.

Definition at line 36 of file kig_document.h.


Public Member Functions

 KigDocument ()
 KigDocument (std::set< ObjectHolder * > objects, CoordinateSystem *coordsystem, bool showgrid=true, bool showaxes=true, bool nv=false)
 ~KigDocument ()
const CoordinateSystem & coordinateSystem () const
bool grid () const
bool axes () const
bool getNightVision () const
const std::vector< ObjectHolder * > objects () const
const std::set< ObjectHolder * > & objectsSet () const
CoordinateSystem * switchCoordinateSystem (CoordinateSystem *s)
void setCoordinateSystem (CoordinateSystem *s)
void setGrid (bool showgrid)
void setAxes (bool showaxes)
void setNightVision (bool nv)
std::vector< ObjectHolder * > whatAmIOn (const Coordinate &p, const KigWidget &w) const
std::vector< ObjectHolder * > whatIsInHere (const Rect &p, const KigWidget &)
Rect suggestedRect () const
void addObject (ObjectHolder *oObject)
void addObjects (const std::vector< ObjectHolder * > &os)
void delObject (ObjectHolder *o)
void delObjects (const std::vector< ObjectHolder * > &os)
std::vector< ObjectCalcer * > findIntersectionPoints (const ObjectCalcer *c1, const ObjectCalcer *c2)

Constructor & Destructor Documentation

KigDocument::KigDocument (  ) 

Definition at line 156 of file kig_document.cc.

KigDocument::KigDocument ( std::set< ObjectHolder * >  objects,
CoordinateSystem *  coordsystem,
bool  showgrid = true,
bool  showaxes = true,
bool  nv = false 
)

Definition at line 30 of file kig_document.cc.

KigDocument::~KigDocument (  ) 

Definition at line 164 of file kig_document.cc.


Member Function Documentation

const CoordinateSystem & KigDocument::coordinateSystem (  )  const

Definition at line 37 of file kig_document.cc.

bool KigDocument::grid (  )  const

Definition at line 178 of file kig_document.cc.

bool KigDocument::axes (  )  const

Definition at line 193 of file kig_document.cc.

bool KigDocument::getNightVision (  )  const

Definition at line 198 of file kig_document.cc.

const std::vector< ObjectHolder * > KigDocument::objects (  )  const

Get a hold of the objects of this KigDocument.

Definition at line 43 of file kig_document.cc.

const std::set< ObjectHolder * > & KigDocument::objectsSet (  )  const

Definition at line 48 of file kig_document.cc.

CoordinateSystem * KigDocument::switchCoordinateSystem ( CoordinateSystem *  s  ) 

sets the coordinate system to s , and returns the old one.

Definition at line 58 of file kig_document.cc.

void KigDocument::setCoordinateSystem ( CoordinateSystem *  s  ) 

sets the coordinate system to s , and deletes the old one.

Definition at line 53 of file kig_document.cc.

void KigDocument::setGrid ( bool  showgrid  ) 

set to show/hide the grid.

Definition at line 173 of file kig_document.cc.

void KigDocument::setAxes ( bool  showaxes  ) 

set to show/hide the grid.

Definition at line 183 of file kig_document.cc.

void KigDocument::setNightVision ( bool  nv  ) 

set to enable/disable night-vision (visibility of hidden objects)

Definition at line 188 of file kig_document.cc.

std::vector< ObjectHolder * > KigDocument::whatAmIOn ( const Coordinate &  p,
const KigWidget &  w 
) const

Return a vector of objects that contain the given point.

Definition at line 65 of file kig_document.cc.

std::vector< ObjectHolder * > KigDocument::whatIsInHere ( const Rect &  p,
const KigWidget &  w 
)

Return a vector of objects that are in the given Rect.

Definition at line 84 of file kig_document.cc.

Rect KigDocument::suggestedRect (  )  const

Return a rect containing most of the objects, which would be a fine suggestion to map to the widget.

..

Definition at line 99 of file kig_document.cc.

void KigDocument::addObject ( ObjectHolder *  oObject  ) 

Add the objects o to the document.

Definition at line 131 of file kig_document.cc.

void KigDocument::addObjects ( const std::vector< ObjectHolder * > &  os  ) 

Add the objects os to the document.

Definition at line 136 of file kig_document.cc.

void KigDocument::delObject ( ObjectHolder *  o  ) 

Remove the object o from the document.

Definition at line 144 of file kig_document.cc.

void KigDocument::delObjects ( const std::vector< ObjectHolder * > &  os  ) 

Remove the objects os from the document.

Definition at line 149 of file kig_document.cc.

std::vector< ObjectCalcer * > KigDocument::findIntersectionPoints ( const ObjectCalcer *  c1,
const ObjectCalcer *  c2 
)

Return all the points that belong (by construction) on both the given curves.

This is useful when the user asks for an intersection point between a conic and a line (or two circles) and one is already there.

Definition at line 216 of file kig_document.cc.


The documentation for this class was generated from the following files:
  • kig_document.h
  • kig_document.cc

kig

Skip menu "kig"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

kdeedu

Skip menu "kdeedu"
  • kalzium
  • kanagram
  • kig
  • klettres
  • kstars
  • libkdeedu
  •   keduvocdocument
  •   docs
  •   src
  • parley
Generated for kdeedu by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal