Ipelib
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
ipe::Object Class Referenceabstract

#include <ipeobject.h>

Inherited by ipe::Group, ipe::Image, ipe::Path, ipe::Reference, and ipe::Text.

Public Types

enum  Type {
  EGroup, EPath, EText, EImage,
  EReference
}
 

Public Member Functions

virtual ~Object ()=0
 
virtual void accept (Visitor &visitor) const =0
 
virtual Objectclone () const =0
 
virtual GroupasGroup ()
 
virtual const GroupasGroup () const
 
virtual TextasText ()
 
virtual PathasPath ()
 
virtual ImageasImage ()
 
virtual ReferenceasReference ()
 
virtual Type type () const =0
 
virtual TPinned pinned () const
 
void setPinned (TPinned pin)
 
TTransformations transformations () const
 
void setTransformations (TTransformations trans)
 
void setMatrix (const Matrix &matrix)
 
const Matrixmatrix () const
 
virtual bool setAttribute (Property prop, Attribute value)
 
virtual Attribute getAttribute (Property prop) const noexcept
 
virtual void saveAsXml (Stream &stream, String layer) const =0
 
virtual void draw (Painter &painter) const =0
 
virtual void drawSimple (Painter &painter) const =0
 
virtual double distance (const Vector &v, const Matrix &m, double bound) const =0
 
virtual void addToBBox (Rect &box, const Matrix &m, bool cp) const =0
 
virtual void snapVtx (const Vector &mouse, const Matrix &m, Vector &pos, double &bound) const
 
virtual void snapCtl (const Vector &mouse, const Matrix &m, Vector &pos, double &bound) const
 
virtual void snapBnd (const Vector &mouse, const Matrix &m, Vector &pos, double &bound) const
 
virtual void checkStyle (const Cascade *sheet, AttributeSeq &seq) const
 

Protected Member Functions

 Object ()
 
 Object (const AllAttributes &attr)
 
 Object (const Object &rhs)
 
 Object (const XmlAttributes &attr)
 
void saveAttributesAsXml (Stream &stream, String layer) const
 

Static Protected Member Functions

static void checkSymbol (Kind kind, Attribute attr, const Cascade *sheet, AttributeSeq &seq)
 

Protected Attributes

Matrix iMatrix
 
TPinned iPinned: 8
 
TTransformations iTransformations: 8
 

Detailed Description

Base class for all Ipe objects, composite or leaf.

All objects are derived from this class. It provides functionality common to all objects, and carries the standard attributes.

All Object's provide a constant time copy constructor (and a virtual Object::clone() method). Objects of non-constant size realize this by separating the implementation and using reference counting. In particular, copying a composite object does not create new copies of the components.

Object has only three attributes: the transformation matrix, the pinning status, and the allowed transformations.

If an object is pinned, it cannot be moved at all (or only in the non-pinned direction) from the Ipe user interface.

Restricting the allowed transformations works somewhat differently: It doesn't stop transformations being applied to the object, but they only effect the position of the reference point (the origin of the object coordinate system), and (if transformations() == ETransformationsRigidMotions) the orientation of the object coordinate system.

Member Enumeration Documentation

Enumerator
EGroup 
EPath 
EText 
EImage 
EReference 

Constructor & Destructor Documentation

Object::~Object ( )
pure virtual

Pure virtual destructor.

Object::Object ( )
explicitprotected

Create object with identity matrix, no pinning, all transformations.

References ipe::ENoPin, ipe::ETransformationsAffine, iPinned, and iTransformations.

Referenced by matrix().

Object::Object ( const AllAttributes attr)
explicitprotected

Create object by taking pinning/transforming from attr and setting identity matrix.

References iPinned, ipe::AllAttributes::iPinned, iTransformations, and ipe::AllAttributes::iTransformations.

Object::Object ( const Object rhs)
protected

Copy constructor.

References iMatrix, iPinned, and iTransformations.

Object::Object ( const XmlAttributes attr)
explicitprotected

Construct from XML stream.

Member Function Documentation

virtual void ipe::Object::accept ( Visitor visitor) const
pure virtual
virtual Object* ipe::Object::clone ( ) const
pure virtual

Make a copy of this object (constant-time).

Implemented in ipe::Group, ipe::Reference, ipe::Text, ipe::Path, and ipe::Image.

Referenced by ipe::Symbol::operator=(), and ipe::Symbol::Symbol().

Group * Object::asGroup ( )
virtual

Return pointer to this object if it is an Group, nullptr otherwise.

Reimplemented in ipe::Group.

Referenced by ipe::PdfWriter::createPageView().

const Group * Object::asGroup ( ) const
virtual

Return pointer to this object if it is an Group, nullptr otherwise.

Reimplemented in ipe::Group.

Text * Object::asText ( )
virtual

Return pointer to this object if it is an Text, nullptr otherwise.

Reimplemented in ipe::Text.

Path * Object::asPath ( )
virtual

Return pointer to this object if it is an Path, nullptr otherwise.

Reimplemented in ipe::Path.

Image * Object::asImage ( )
virtual

Return pointer to this object if it is an Image , nullptr otherwise.

Reimplemented in ipe::Image.

Reference * Object::asReference ( )
virtual

Return pointer to this object if it is an Ref, nullptr otherwise.

Reimplemented in ipe::Reference.

virtual Type ipe::Object::type ( ) const
pure virtual
TPinned Object::pinned ( ) const
virtual

Return pinning mode of the object.

Reimplemented in ipe::Group.

References iPinned.

Referenced by getAttribute(), ipe::Group::pinned(), ipe::Group::push_back(), and ipe::TransformTool::TransformTool().

void Object::setPinned ( TPinned  pin)

Set pinning mode of the object.

References iPinned.

TTransformations ipe::Object::transformations ( ) const
inline
void Object::setTransformations ( TTransformations  trans)

Set allowed transformations of the object.

References iTransformations.

Referenced by ipe::Text::setAttribute(), and transformations().

void Object::setMatrix ( const Matrix matrix)

Set the transformation matrix.

Don't use this on an Object in a Page, because it wouldn't invalidate its bounding box. Call Page::transform instead.

References iMatrix, and matrix().

Referenced by ipe::Page::applyTitleStyle(), ipe::Page::transform(), and transformations().

const Matrix& ipe::Object::matrix ( ) const
inline
bool Object::setAttribute ( Property  prop,
Attribute  value 
)
virtual
Attribute Object::getAttribute ( Property  prop) const
virtualnoexcept

Get setting of an attribute of this object.

If object does not have this attribute, returnes "undefined" attribute.

Reimplemented in ipe::Group, ipe::Path, ipe::Reference, and ipe::Text.

References ipe::EPropPinned, ipe::EPropTransformations, iTransformations, pinned(), and ipe::Attribute::UNDEFINED().

Referenced by ipe::Text::getAttribute(), ipe::Reference::getAttribute(), ipe::Path::getAttribute(), ipe::Group::getAttribute(), and matrix().

virtual void ipe::Object::saveAsXml ( Stream stream,
String  layer 
) const
pure virtual

Save the object in XML format.

Implemented in ipe::Path, ipe::Group, ipe::Reference, ipe::Text, and ipe::Image.

Referenced by matrix().

virtual void ipe::Object::draw ( Painter painter) const
pure virtual
virtual void ipe::Object::drawSimple ( Painter painter) const
pure virtual

Draw simple version for selecting and transforming.

Implemented in ipe::Path, ipe::Group, ipe::Reference, ipe::Text, and ipe::Image.

Referenced by ipe::PanTool::draw(), ipe::SelectTool::draw(), ipe::TransformTool::draw(), and matrix().

virtual double ipe::Object::distance ( const Vector v,
const Matrix m,
double  bound 
) const
pure virtual

Return distance of transformed object to point v. If larger than bound, can just return bound.

Implemented in ipe::Path, ipe::Group, ipe::Text, ipe::Reference, and ipe::Image.

Referenced by ipe::Page::distance(), and matrix().

virtual void ipe::Object::addToBBox ( Rect box,
const Matrix m,
bool  cp 
) const
pure virtual

Extend box to include the object transformed by m.

For objects in a page, don't call this directly. The Page caches the bounding box of each object, so it is far more efficient to call Page::bbox.

Control points that lie outside the visual object are included if cp is true.

If called with an empty box and cp == false, the result of this function is a tight bounding box for the object, with a little leeway in case the boundary is determined by a spline (it has to be approximated to perform this operation).

Implemented in ipe::Path, ipe::Group, ipe::Text, ipe::Reference, and ipe::Image.

Referenced by matrix(), and ipe::SelectTool::mouseButton().

void Object::snapVtx ( const Vector mouse,
const Matrix m,
Vector pos,
double &  bound 
) const
virtual

Compute vertex snapping position for transformed object.

Looks only for positions closer than bound. If successful, modify pos and bound. The default implementation does nothing.

Reimplemented in ipe::Path, ipe::Group, and ipe::Reference.

Referenced by matrix(), and ipe::Page::snapVtx().

void Object::snapCtl ( const Vector mouse,
const Matrix m,
Vector pos,
double &  bound 
) const
virtual

Compute control point snapping position for transformed object.

Looks only for positions closer than bound. If successful, modify pos and bound. The default implementation does nothing.

Reimplemented in ipe::Path, ipe::Group, ipe::Text, and ipe::Image.

Referenced by matrix(), and ipe::Page::snapCtl().

void Object::snapBnd ( const Vector mouse,
const Matrix m,
Vector pos,
double &  bound 
) const
virtual

Compute boundary snapping position for transformed object.

Looks only for positions closer than bound. If successful, modify pos and bound. The default implementation does nothing.

Reimplemented in ipe::Path, ipe::Group, and ipe::Reference.

References ipe::Visitor::~Visitor().

Referenced by matrix(), and ipe::Page::snapBnd().

void Object::checkStyle ( const Cascade sheet,
AttributeSeq seq 
) const
virtual

Check all symbolic attributes.

Reimplemented in ipe::Group, ipe::Path, ipe::Reference, and ipe::Text.

Referenced by ipe::Document::checkStyle(), and matrix().

void Object::saveAttributesAsXml ( Stream stream,
String  layer 
) const
protected
void Object::checkSymbol ( Kind  kind,
Attribute  attr,
const Cascade sheet,
AttributeSeq seq 
)
staticprotected

Check whether attribute is either absolute or defined in the style sheet cascade sheet. Add attr to seq if this is not the case.

References ipe::Cascade::findDefinition(), and ipe::Attribute::isSymbolic().

Referenced by ipe::Text::checkStyle(), ipe::Reference::checkStyle(), ipe::Path::checkStyle(), and matrix().

Member Data Documentation

Matrix ipe::Object::iMatrix
protected
TPinned ipe::Object::iPinned
protected
TTransformations ipe::Object::iTransformations
protected

The documentation for this class was generated from the following files: