Public Types | Public Member Functions | Static Public Member Functions | List of all members
ipe::Reference Class Reference

#include <ipereference.h>

Inherits ipe::Object.

Public Types

enum  {
  EHasStroke = 0x001 , EHasFill = 0x002 , EHasPen = 0x004 , EHasSize = 0x008 ,
  EIsMark = 0x010 , EIsArrow = 0x020
- Public Types inherited from ipe::Object
enum  Type {
  EGroup , EPath , EText , EImage ,

Public Member Functions

 Reference (const AllAttributes &attr, Attribute name, Vector pos)
 Reference (const XmlAttributes &attr, String data)
virtual Objectclone () const
virtual ReferenceasReference ()
virtual Type type () const
virtual void accept (Visitor &visitor) const
virtual void saveAsXml (Stream &stream, String layer) const
virtual void draw (Painter &painter) const
virtual void drawSimple (Painter &painter) const
virtual void addToBBox (Rect &box, const Matrix &m, bool cp) const
virtual double distance (const Vector &v, const Matrix &m, double bound) const
virtual void snapVtx (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
void setName (Attribute name)
Attribute name () const
void setStroke (Attribute color)
Attribute stroke () const
void setFill (Attribute color)
Attribute fill () const
Attribute pen () const
void setPen (Attribute pen)
void setSize (Attribute size)
Attribute size () const
Vector position () const
virtual bool setAttribute (Property prop, Attribute value)
virtual Attribute getAttribute (Property prop) const noexcept
uint32_t flags () const
- Public Member Functions inherited from ipe::Object
virtual ~Object ()=0
virtual GroupasGroup ()
virtual const GroupasGroup () const
virtual TextasText ()
virtual PathasPath ()
virtual ImageasImage ()
virtual TPinned pinned () const
void setPinned (TPinned pin)
TTransformations transformations () const
void setTransformations (TTransformations trans)
virtual void setMatrix (const Matrix &matrix)
const Matrixmatrix () const
void setCustom (Attribute value)
Attribute getCustom () const noexcept
virtual void snapCtl (const Vector &mouse, const Matrix &m, Vector &pos, double &bound) const

Static Public Member Functions

static uint32_t flagsFromName (String name)

Additional Inherited Members

- Protected Member Functions inherited from ipe::Object
 Object ()
 Object (const AllAttributes &attr)
 Object (const Object &rhs)
 Object (const XmlAttributes &attr)
void saveAttributesAsXml (Stream &stream, String layer) const
- Static Protected Member Functions inherited from ipe::Object
static void checkSymbol (Kind kind, Attribute attr, const Cascade *sheet, AttributeSeq &seq)
- Protected Attributes inherited from ipe::Object
Matrix iMatrix
Attribute iCustom
TPinned iPinned: 8
TTransformations iTransformations: 8

Detailed Description

The reference object.

A Reference uses a symbol, that is, an object defined in an Ipe StyleSheet. The object is defined as a named symbol in the style sheet, and can be reused arbitrarily often in the document. This can, for instance, be used for backgrounds on multi-page documents.

It is admissible to refer to an undefined object (that is, the current style sheet cascade does not define a symbol with the given name). Nothing will be drawn in this case.

The Reference has a stroke, fill, and pen attribute. When drawing a symbol, these attributes are made available to the symbol through the names "sym-stroke", "sym-fill", and "sym-pen". These are not defined by the style sheet, but resolved by the Painter when the symbol sets its attributes.

Note that it is not possible to determine whether a symbol is filled from the Reference object.

The size attribute is of type ESymbolSize, and indicates a magnification factor applied to the symbol. This magnification is applied after the untransformation indicated in the Reference and in the Symbol has been performed, so that symbols are magnified even if they specify ETransformationsTranslations.

The size is meant for symbols such as marks, that can be shown in different sizes. Another application of symbols is for backgrounds and logos. Their size should not be changed when the user changes the symbolsize for the entire page. For such symbols, the size attribute of the Reference should be set to the absolute value zero. This means that no magnification is applied to the object, and it also stops setAttribute() from modifying the size. (The size can still be changed using setSize(), but this is not available from Lua.)

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Constructor & Destructor Documentation

◆ Reference() [1/2]

Reference::Reference ( const AllAttributes attr,
Attribute  name,
Vector  pos 

◆ Reference() [2/2]

Reference::Reference ( const XmlAttributes attr,
String  data 

Member Function Documentation

◆ clone()

Object * Reference::clone ( ) const

Clone object.

Implements ipe::Object.

References Reference().

◆ asReference()

Reference * Reference::asReference ( )

Return pointer to this object.

Reimplemented from ipe::Object.

◆ type()

Object::Type Reference::type ( ) const

Implements ipe::Object.

References ipe::Object::EReference.

◆ accept()

void Reference::accept ( Visitor visitor) const

Call visitReference of visitor.

Implements ipe::Object.

References ipe::Visitor::visitReference().

◆ saveAsXml()

void Reference::saveAsXml ( Stream stream,
String  layer 
) const

◆ draw()

void Reference::draw ( Painter painter) const

◆ drawSimple()

void Reference::drawSimple ( Painter painter) const

◆ addToBBox()

void Reference::addToBBox ( Rect box,
const Matrix m,
bool  cp 
) const

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).

This only adds the position (or the snap positions) to the box.

Implements ipe::Object.

References ipe::Rect::addPoint(), and ipe::Object::matrix().

◆ distance()

double Reference::distance ( const Vector v,
const Matrix m,
double  bound 
) const

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

Implements ipe::Object.

References ipe::Object::matrix().

◆ snapVtx()

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

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 from ipe::Object.

References ipe::Object::matrix().

◆ snapBnd()

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

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 from ipe::Object.

◆ checkStyle()

void Reference::checkStyle ( const Cascade sheet,
AttributeSeq seq 
) const

◆ setName()

void Reference::setName ( Attribute  name)

Set name of symbol referenced.

References flagsFromName(), name(), and ipe::Attribute::string().

Referenced by setAttribute().

◆ name()

Attribute ipe::Reference::name ( ) const

Return symbolic name.

Referenced by flagsFromName(), Reference(), setAttribute(), and setName().

◆ setStroke()

void Reference::setStroke ( Attribute  color)

Set stroke color.

Referenced by setAttribute().

◆ stroke()

Attribute ipe::Reference::stroke ( ) const

Return stroke color.

Referenced by setAttribute().

◆ setFill()

void Reference::setFill ( Attribute  color)

Set fill color.

Referenced by setAttribute().

◆ fill()

Attribute ipe::Reference::fill ( ) const

Return fill color.

Referenced by setAttribute().

◆ pen()

Attribute ipe::Reference::pen ( ) const

Return pen.

Referenced by setAttribute(), and setPen().

◆ setPen()

void Reference::setPen ( Attribute  pen)

Set pen.

References pen().

Referenced by setAttribute().

◆ setSize()

void Reference::setSize ( Attribute  size)

Set size (magnification) of symbol.

References size().

Referenced by setAttribute().

◆ size()

Attribute ipe::Reference::size ( ) const

Return symbol size.

Referenced by drawSimple(), setAttribute(), and setSize().

◆ position()

Vector ipe::Reference::position ( ) const

Return position of symbol on page.

◆ setAttribute()

bool Reference::setAttribute ( Property  prop,
Attribute  value 

◆ getAttribute()

Attribute Reference::getAttribute ( Property  prop) const

Get setting of an attribute of this object.

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

Reimplemented from ipe::Object.

References ipe::EPropFillColor, ipe::EPropMarkShape, ipe::EPropPen, ipe::EPropStrokeColor, ipe::EPropSymbolSize, ipe::Object::getAttribute(), and ipe::size().

◆ flags()

uint32_t ipe::Reference::flags ( ) const

Referenced by flagsFromName().

◆ flagsFromName()

uint32_t Reference::flagsFromName ( String  name)

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