minsky::Item Class Reference

#include <item.h>

Inheritance diagram for minsky::Item:

Collaboration diagram for minsky::Item:

Classes
struct	MemoisedRotator

Public Member Functions
	Item ()
virtual std::weak_ptr< Port >	ports (std::size_t i) const
	callback to be run when item deleted from group More...
std::size_t	portsSize () const
	number of ports More...
float	portX (std::size_t i)
float	portY (std::size_t i)
virtual bool	contains (float xx, float yy) const
bool	contains (const Point &p) const
void	updateBoundingBox () override
void	throw_error (const std::string &) const
	mark item on canvas, then throw More...
virtual bool	ioVar () const
	indicates this is a group I/O variable More...
virtual double	value () const
	current value of output port More...
double	rotation () const
double	rotation (const double &r)
std::pair< double, bool >	rotationAsRadians () const
	return the rotation as radians, and whether rotation should have additional straight angle added for text that stays upright. More...
float	iWidth () const
float	iWidth (const float &w)
float	iHeight () const
float	iHeight (const float &h)
virtual void	flip ()
	rotate icon though 180∘ More...
virtual std::string	classType () const
std::string	id () const
	return an id uniquely identifying this item More...
virtual float	x () const
virtual float	y () const
virtual float	zoomFactor () const
void	ensureBBValid () const
float	width () const
float	height () const
virtual std::vector< Point >	corners () const
float	left () const
float	right () const
float	top () const
float	bottom () const
std::string	bookmarkId () const
	Id of bookmark associated with this. More...
void	adjustBookmark () const override
	adjust bookmark list to reflect current configuration More...
float	resizeHandleSize () const
	resize handles should be at least a percentage if the icon size (#1025) More...
virtual bool	onResizeHandle (float x, float y) const
virtual bool	inItem (float x, float y) const
virtual bool	onItem (float x, float y) const
	returns true if (x,y) is on the icon More...
virtual void	onMouseDown (float x, float y)
	respond to mouse down events More...
virtual void	onMouseUp (float x, float y)
	respond to mouse up events More...
virtual bool	onMouseMotion (float x, float y)
	respond to mouse motion events with button pressed More...
virtual bool	onMouseOver (float x, float y)
	respond to mouse motion events (hover) without button pressed More...
virtual void	onMouseLeave ()
	respond to mouse leave events (when mouse leaves item) More...
virtual bool	onKeyPress (int keySym, const std::string &utf8, int state)
	respond to key press events More...
virtual void	deleteAttachedWires ()
	delete all attached wires More...
virtual Item *	clone () const
virtual bool	visible () const
	whether this item is visible on the canvas. More...
void	moveTo (float x, float y)
virtual void	draw (cairo_t *cairo) const
	draw this item into a cairo context More...
virtual void	resize (const LassoBox &b)
	resize this item on the canvas More...
virtual float	scaleFactor () const
	factor by which item has been resized More...
virtual float	scaleFactor (const float &sf)
void	dummyDraw () const
	draw into a dummy cairo context, for purposes of calculating port positions More...
virtual void	displayTooltip (cairo_t *, const std::string &) const
	display tooltip text, eg on mouseover More...
virtual void	updateIcon (double t)
	update display after a step() More...
	Item (const Item &)=default
Item &	operator= (const Item &)=default
virtual	~Item ()
void	drawPorts (cairo_t *cairo) const
virtual void	drawResizeHandles (cairo_t *cairo) const
virtual ClickType::Type	clickType (float x, float y) const
	returns the clicktype given a mouse click at x, y. More...
virtual std::shared_ptr< Port >	closestOutPort (float x, float y) const
	returns closest output port to x,y More...
virtual std::shared_ptr< Port >	closestInPort (float x, float y) const
virtual std::shared_ptr< Item >	select (float x, float y) const
	returns the variable if point (x,y) is within a visible variable icon, null otherwise. More...
virtual void	TCL_obj (classdesc::TCL_obj_t &t, const std::string &d)
	runs the TCL_obj descriptor suitable for this type More...
void	RESTProcess (classdesc::RESTProcess_t &rp, const std::string &d) override
	runs the RESTProcess descriptor suitable for this type More...
void	RESTProcess (classdesc::RESTProcess_t &rp, const std::string &d) const override
virtual void	json_pack (classdesc::json_pack_t &j) const
virtual void	displayDelayedTooltip (float x, float y)
	enable extended tooltip help message appropriate for mouse at (x,y) More...
virtual void	disableDelayedTooltip ()
virtual bool	editorMode () const
	some items have an editor mode attribute More...
virtual void	toggleEditorMode ()
virtual Units	units (bool check=false) const
	compute the dimensional units More...
Units	checkUnits () const
	perform units consistency checks More...
ItemPtr	itemPtrFromThis () const
	return a shared_ptr to this More...
virtual void	destroyFrame ()
	destroy any popup windows associated with this More...
Public Member Functions inherited from minsky::NoteBase
virtual std::string const &	detailedText () const
virtual std::string const &	detailedText (const std::string &x)
virtual std::string const &	tooltip () const
virtual std::string const &	tooltip (const std::string &x)
virtual	~NoteBase ()=default

Static Public Member Functions
static void	drawSelected (cairo_t *cairo)

Public Attributes
float	m_x =0
float	m_y =0
	position in canvas, or within group More...
float	m_sf =1
	scale factor of item on canvas, or within group More...
bool	onResizeHandles =false
	set to true to indicate mouse is ovcaler resize handles More...
bool	onBorder =false
	true to indicate mouse hovering over border More...
std::string	deleteCallback
BoundingBox	bb
	canvas bounding box. More...
Public Attributes inherited from minsky::NoteBase
bool	mouseFocus =false
	true if target of a mouseover More...
bool	selected =false
	true if selected for cut, copy or group operation More...
bool	bookmark =false
	Is this item also a bookmark? More...

Static Protected Member Functions
static void	drawResizeHandle (cairo_t *cairo, double x, double y, double sf, double angle)

Protected Attributes
double	m_width =10
double	m_height =10
ItemPortVector	m_ports
minsky::Item::MemoisedRotator	memoisedRotator

Detailed Description

Definition at line 148 of file item.h.

Constructor & Destructor Documentation

Item() [1/2]

minsky::Item::Item ( )

inline

Definition at line 172 of file item.h.

Referenced by clone().

: TCLAccessor<Item,double>("rotation",(Getter)&Item::rotation,(Setter)&Item::rotation) {}

Here is the caller graph for this function:

Item() [2/2]

minsky::Item::Item ( const Item &  )

default

~Item()

virtual minsky::Item::~Item ( )

inlinevirtual

Definition at line 313 of file item.h.

{}

Member Function Documentation

adjustBookmark()

void minsky::Item::adjustBookmark ( ) const

overridevirtual

adjust bookmark list to reflect current configuration

Reimplemented from minsky::NoteBase.

Definition at line 192 of file item.cc.

References minsky::Minsky::bookmarkRefresh(), and pyminsky::minsky.

  {
    if (auto g=group.lock())
      {
        auto& bookmarks=g->bookmarks;
        if (bookmark)
          g->addBookmarkXY(left(),top(),bookmarkId());
        else
          bookmarks.erase(bookmarkId());
        minsky().bookmarkRefresh();
      }
  }

Here is the call graph for this function:

bookmarkId()

std::string minsky::Item::bookmarkId ( ) const

inline

Id of bookmark associated with this.

Definition at line 251 of file item.h.

References minsky::to_string(), and minsky::NoteBase::tooltip().

Referenced by minsky::GroupItems::removeItem().

{return tooltip().empty()? std::to_string(size_t(this)): tooltip();}

Here is the call graph for this function:

Here is the caller graph for this function:

bottom()

float minsky::Item::bottom

(

)

const

Definition at line 184 of file item.cc.

Referenced by height(), and minsky::LassoBox::intersects().

  {
    auto bottom=y();
    for (auto& p: corners())
      if (p.y()>bottom) bottom=p.y();
    return bottom;
  }

Here is the caller graph for this function:

checkUnits()

Units minsky::Item::checkUnits ( ) const

inline

perform units consistency checks

Definition at line 357 of file item.h.

References units().

{return units(true);}

Here is the call graph for this function:

classType()

virtual std::string minsky::Item::classType ( ) const

inlinevirtual

Reimplemented in minsky::VarConstant, minsky::Variable< T >, minsky::Variable< VariableType::constant >, minsky::Operation< T >, minsky::Operation< OperationType::differentiate >, minsky::Operation< OperationType::copy >, minsky::Operation< OperationType::userFunction >, minsky::Operation< OperationType::time >, minsky::Operation< OperationType::ravel >, minsky::Operation< minsky::OperationType::data >, minsky::Operation< minsky::OperationType::integrate >, minsky::ItemT< DataOp, Operation< minsky::OperationType::data > >, minsky::ItemT< GodleyIcon >, minsky::ItemT< Operation< T >, OperationBase >, minsky::ItemT< Sheet >, minsky::ItemT< Ravel, Operation< OperationType::ravel > >, minsky::ItemT< SwitchIcon, BottomRightResizerItem >, minsky::ItemT< PlotWidget >, minsky::ItemT< IntOp, Operation< minsky::OperationType::integrate > >, minsky::ItemT< Lock >, minsky::ItemT< Variable< T >, VariableBase >, minsky::ItemT< Group >, and minsky::ItemT< UserFunction, Operation< OperationType::userFunction > >.

Definition at line 234 of file item.h.

{return "Item";}

clickType()

ClickType::Type minsky::Item::clickType ( float  x, float  y  ) const

virtual

returns the clicktype given a mouse click at x, y.

Reimplemented in minsky::Group, minsky::VariableBase, minsky::PlotWidget, minsky::GodleyIcon, and minsky::Sheet.

Definition at line 275 of file item.cc.

References minsky::portRadius.

Referenced by minsky::VariableBase::clickType().

  {                 
    // if selecting a contained variable, the delegate to that
    if (auto item=select(x,y))
      return item->clickType(x,y);
    
    // firstly, check whether a port has been selected
    for (auto& p: m_ports)
      {
        if (hypot(x-p->x(), y-p->y()) < portRadius*zoomFactor())
          return ClickType::onPort;
      }          

    if (onResizeHandle(x,y)) return ClickType::onResize;         
    if (inItem(x,y)) return ClickType::inItem;
    if (onItem(x,y)) return ClickType::onItem;               
    return ClickType::outside;
  }

Here is the caller graph for this function:

clone()

virtual Item* minsky::Item::clone ( ) const

inlinevirtual

Reimplemented in minsky::VarConstant, minsky::Variable< T >, minsky::Variable< VariableType::constant >, minsky::Group, minsky::VariableBase, minsky::GodleyIcon, minsky::ItemT< DataOp, Operation< minsky::OperationType::data > >, minsky::ItemT< GodleyIcon >, minsky::ItemT< Operation< T >, OperationBase >, minsky::ItemT< Sheet >, minsky::ItemT< Ravel, Operation< OperationType::ravel > >, minsky::ItemT< SwitchIcon, BottomRightResizerItem >, minsky::ItemT< PlotWidget >, minsky::ItemT< IntOp, Operation< minsky::OperationType::integrate > >, minsky::ItemT< Lock >, minsky::ItemT< Variable< T >, VariableBase >, minsky::ItemT< Group >, and minsky::ItemT< UserFunction, Operation< OperationType::userFunction > >.

Definition at line 282 of file item.h.

References Item().

                                {
      auto r=new Item(*this);
      r->group.reset();
      return r;
    }

Here is the call graph for this function:

closestInPort()

shared_ptr< Port > minsky::Item::closestInPort ( float  x, float  y  ) const

virtual

Definition at line 428 of file item.cc.

References minsky::sqr().

  {
    if (auto v=select(x,y))
      return v->closestInPort(x,y);
    shared_ptr<Port> r;
    for (size_t i=0; i<m_ports.size(); ++i)
      if (m_ports[i]->input() &&
          (!r || sqr(m_ports[i]->x()-x)+sqr(m_ports[i]->y()-y) <
           sqr(r->x()-x)+sqr(r->y()-y)))
        r=m_ports[i];
    return r;
  }

Here is the call graph for this function:

closestOutPort()

shared_ptr< Port > minsky::Item::closestOutPort ( float  x, float  y  ) const

virtual

returns closest output port to x,y

Definition at line 421 of file item.cc.

  {
    if (auto v=select(x,y))
      return v->closestOutPort(x,y);
    return portsSize()>0 && !ports(0).lock()->input()? ports(0).lock(): nullptr;
  }

contains() [1/2]

virtual bool minsky::Item::contains ( float  xx, float  yy  ) const

inlinevirtual

Reimplemented in minsky::PlotWidget, and minsky::Sheet.

Definition at line 196 of file item.h.

References left(), resizeHandleSize(), and top().

Referenced by minsky::Sheet::contains().

                                                    {
      auto hz=resizeHandleSize(); // extend by resize handle size (which is also portRadius)
      return left()-hz<=xx && right()+hz>=xx && top()-hz<=yy && bottom()+hz>=yy; 
    }

Here is the call graph for this function:

Here is the caller graph for this function:

contains() [2/2]

bool minsky::Item::contains ( const Point &  p ) const

inline

Definition at line 200 of file item.h.

References contains().

Referenced by contains().

{return contains(p.x(),p.y());}

Here is the call graph for this function:

Here is the caller graph for this function:

corners()

std::vector< Point > minsky::Item::corners ( ) const

virtual

Reimplemented in minsky::Sheet.

Definition at line 153 of file item.cc.

  {
    ensureBBValid();
    auto left=x()+bb.left()*zoomFactor(), right=x()+bb.right()*zoomFactor();
    auto top=y()+bb.top()*zoomFactor(), bottom=y()+bb.bottom()*zoomFactor();
    memoisedRotator.update(rotation(),x(),y());
    return {memoisedRotator(left,top),memoisedRotator(left,bottom),
        memoisedRotator(right,bottom),memoisedRotator(right,top)};
  }

deleteAttachedWires()

void minsky::Item::deleteAttachedWires ( )

virtual

delete all attached wires

Reimplemented in minsky::Group.

Definition at line 139 of file item.cc.

  {
    for (auto& p: m_ports)
      p->deleteWires();
  }

destroyFrame()

virtual void minsky::Item::destroyFrame ( )

inlinevirtual

destroy any popup windows associated with this

Reimplemented in minsky::VariableBase, minsky::PlotWidget, and minsky::GodleyIcon.

Definition at line 363 of file item.h.

{}

disableDelayedTooltip()

virtual void minsky::Item::disableDelayedTooltip ( )

inlinevirtual

Definition at line 342 of file item.h.

{}

displayDelayedTooltip()

virtual void minsky::Item::displayDelayedTooltip ( float  x, float  y  )

inlinevirtual

enable extended tooltip help message appropriate for mouse at (x,y)

Reimplemented in minsky::Ravel.

Definition at line 341 of file item.h.

{}

displayTooltip()

void minsky::Item::displayTooltip ( cairo_t *  cairo, const std::string &  tooltip  ) const

virtual

display tooltip text, eg on mouseover

Reimplemented in minsky::UserFunction.

Definition at line 398 of file item.cc.

References minsky::latexToPango().

Referenced by minsky::UserFunction::displayTooltip(), minsky::IntOp::draw(), minsky::Ravel::draw(), and minsky::VariableBase::draw().

  {
    const string unitstr=units().latexStr();
    if (!tooltip.empty() || !unitstr.empty())
      {
        const cairo::CairoSave cs(cairo);
        Pango pango(cairo);
        string toolTipText=latexToPango(tooltip);
        if (!unitstr.empty())
          toolTipText+=" Units:"+latexToPango(unitstr);
        pango.setMarkup(toolTipText);
        const float z=zoomFactor();
        cairo_translate(cairo,z*(0.5*bb.width())+10,
                        z*(-0.5*bb.height())-20);
        cairo_rectangle(cairo,0,0,pango.width(),pango.height());
        cairo_set_source_rgb(cairo,1,1,1);
        cairo_fill_preserve(cairo);
        cairo_set_source_rgb(cairo,0,0,0);
        pango.show();
        cairo_stroke(cairo);
      }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

draw()

void minsky::Item::draw ( cairo_t *  cairo ) const

virtual

draw this item into a cairo context

Reimplemented in minsky::Group, minsky::VariableBase, minsky::PlotWidget, minsky::GodleyIcon, minsky::Ravel, minsky::OperationBase, minsky::PhillipsStock, minsky::Sheet, minsky::IntOp, minsky::SwitchIcon, minsky::UserFunction, minsky::Lock, and minsky::DataOp.

Definition at line 363 of file item.cc.

References minsky::flipped(), minsky::latexToPango(), M_PI, minsky::Rotate::x(), and minsky::Rotate::y().

Referenced by minsky::BoundingBox::update().

  {
    auto [angle,flipped]=rotationAsRadians();
    const Rotate r(rotation()+(flipped? 180:0),0,0);
    Pango pango(cairo);
    const float z=zoomFactor();
    pango.angle=angle+(flipped? M_PI: 0);
    pango.setFontSize(12.0*scaleFactor()*z);
    pango.setMarkup(latexToPango(detailedText()));         
    // parameters of icon in userspace (unscaled) coordinates
    const float w=0.5*pango.width()+2*z; 
    const float h=0.5*pango.height()+4*z;       

    cairo_move_to(cairo,r.x(-w+1,-h+2), r.y(-w+1,-h+2));
    pango.show();

    if (mouseFocus) {
      displayTooltip(cairo,tooltip());  
    }
    if (onResizeHandles) drawResizeHandles(cairo);      
    cairo_move_to(cairo,r.x(-w,-h), r.y(-w,-h));
    cairo_line_to(cairo,r.x(w,-h), r.y(w,-h));
    cairo_line_to(cairo,r.x(w,h), r.y(w,h));
    cairo_line_to(cairo,r.x(-w,h), r.y(-w,h));
    cairo_close_path(cairo);
    cairo_clip(cairo);
    if (selected) drawSelected(cairo);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

drawPorts()

void minsky::Item::drawPorts

(

cairo_t *

cairo

)

const

Definition at line 294 of file item.cc.

References M_PI, and minsky::portRadius.

Referenced by minsky::IntOp::draw(), minsky::Ravel::draw(), and minsky::VariableBase::draw().

  {
    const CairoSave cs(cairo);
    cairo_new_path(cairo);
    for (auto& p: m_ports)
      {
        cairo_new_sub_path(cairo);
        cairo_arc(cairo, p->x()-x(), p->y()-y(), portRadius*zoomFactor(), 0, 2*M_PI);
      }
    cairo_set_source_rgb(cairo, 0,0,0);
    cairo_set_line_width(cairo,1);
    cairo_stroke(cairo);
  }

Here is the caller graph for this function:

drawResizeHandle()

void minsky::Item::drawResizeHandle ( cairo_t *  cairo, double  x, double  y, double  sf, double  angle  )

staticprotected

Definition at line 316 of file item.cc.

    {
      const cairo::CairoSave cs(cairo);
      cairo_translate(cairo,x,y);
      cairo_rotate(cairo,angle);
      cairo_scale(cairo,sf,sf);
      cairo_move_to(cairo,-1,-.2);
      cairo_line_to(cairo,-1,-1);
      cairo_line_to(cairo,1,1);
      cairo_line_to(cairo,1,0.2);
      cairo_move_to(cairo,-1,-1);
      cairo_line_to(cairo,-.2,-1);
      cairo_move_to(cairo,.2,1);
      cairo_line_to(cairo,1,1);
    }

drawResizeHandles()

void minsky::Item::drawResizeHandles ( cairo_t *  cairo ) const

virtual

Reimplemented in minsky::BottomRightResizerItem, and minsky::Sheet.

Definition at line 343 of file item.cc.

References M_PI.

  {
    auto sf=resizeHandleSize();
    double angle=0.5*M_PI;
    for (auto& p: corners())
      {
        angle+=0.5*M_PI;
        drawResizeHandle(cairo,p.x()-x(),p.y()-y(),sf,angle);
      }
    cairo_stroke(cairo);
  }

drawSelected()

void minsky::Item::drawSelected ( cairo_t *  cairo )

static

Definition at line 308 of file item.cc.

Referenced by minsky::IntOp::draw(), minsky::Ravel::draw(), and minsky::VariableBase::draw().

  {
    // implemented by filling the clip region with a transparent grey
    const CairoSave cs(cairo);
    cairo_set_source_rgba(cairo, 0.5,0.5,0.5,0.4);
    cairo_paint(cairo);
  }

Here is the caller graph for this function:

dummyDraw()

void minsky::Item::dummyDraw

(

)

const

draw into a dummy cairo context, for purposes of calculating port positions

Definition at line 392 of file item.cc.

  {
    const ecolab::cairo::Surface s(cairo_recording_surface_create(CAIRO_CONTENT_COLOR_ALPHA,NULL));
    draw(s.cairo());
  }

editorMode()

virtual bool minsky::Item::editorMode ( ) const

inlinevirtual

some items have an editor mode attribute

Reimplemented in minsky::Ravel, and minsky::GodleyIcon.

Definition at line 345 of file item.h.

{return false;}

ensureBBValid()

void minsky::Item::ensureBBValid ( ) const

inline

Definition at line 241 of file item.h.

References bb, minsky::BoundingBox::update(), and minsky::BoundingBox::valid().

{if (!bb.valid()) bb.update(*this);}

Here is the call graph for this function:

flip()

virtual void minsky::Item::flip ( )

inlinevirtual

rotate icon though 180∘

Reimplemented in minsky::SwitchIcon.

Definition at line 232 of file item.h.

References rotation().

{rotation(rotation()+180);}

Here is the call graph for this function:

height()

float minsky::Item::height ( ) const

inline

Definition at line 243 of file item.h.

References bottom(), and top().

Referenced by minsky::PhillipsStock::draw(), minsky::PlotWidget::height(), minsky::anonymous_namespace{autoLayout.cc}::minD(), and resizeHandleSize().

{return bottom()-top();}

Here is the call graph for this function:

Here is the caller graph for this function:

id()

std::string minsky::Item::id ( ) const

inline

return an id uniquely identifying this item

Definition at line 236 of file item.h.

References minsky::str().

{return str(size_t(this));}

Here is the call graph for this function:

iHeight() [1/2]

float minsky::Item::iHeight ( ) const

inline

Definition at line 224 of file item.h.

References m_height.

Referenced by minsky::VariableBase::clickType(), minsky::IntOp::draw(), minsky::VariableBase::draw(), minsky::GodleyIcon::GodleyIcon(), minsky::Group::Group(), schema3::populateItem(), minsky::IntOp::resize(), and minsky::VariableBase::resize().

{return m_height;}

Here is the caller graph for this function:

iHeight() [2/2]

float minsky::Item::iHeight ( const float &  h )

inline

Definition at line 225 of file item.h.

References bb, m_height, and minsky::BoundingBox::update().

                                  {
      m_height=h;
      bb.update(*this);
      return m_height;
    }         

Here is the call graph for this function:

inItem()

virtual bool minsky::Item::inItem ( float  x, float  y  ) const

inlinevirtual

Returns

true if item internally responds to the mouse, and (x,y) is within editable area

Reimplemented in minsky::GodleyIcon, minsky::Ravel, and minsky::Sheet.

Definition at line 259 of file item.h.

{return false;}

ioVar()

virtual bool minsky::Item::ioVar ( ) const

inlinevirtual

indicates this is a group I/O variable

Reimplemented in minsky::VariableBase.

Definition at line 207 of file item.h.

{return false;}

itemPtrFromThis()

ItemPtr minsky::Item::itemPtrFromThis

(

)

const

return a shared_ptr to this

Definition at line 447 of file item.cc.

Referenced by minsky::Ravel::exportAsCSV(), minsky::Ravel::joinLockGroup(), and minsky::TensorsFromPort::tensorsFromPort().

  {
    if (auto g=group.lock())
      return g->findItem(*this);
    return {};
  }

Here is the caller graph for this function:

iWidth() [1/2]

float minsky::Item::iWidth ( ) const

inline

Definition at line 217 of file item.h.

References m_width.

Referenced by minsky::IntOp::draw(), minsky::VariableBase::draw(), minsky::GodleyIcon::GodleyIcon(), minsky::Group::Group(), minsky::RenderVariable::handlePos(), minsky::VariableBase::onMouseMotion(), schema3::populateItem(), minsky::IntOp::resize(), and minsky::VariableBase::resize().

{return m_width;}

Here is the caller graph for this function:

iWidth() [2/2]

float minsky::Item::iWidth ( const float &  w )

inline

Definition at line 218 of file item.h.

References bb, m_width, and minsky::BoundingBox::update().

                                 {
      m_width=w;
      bb.update(*this);
      return m_width;
    }

Here is the call graph for this function:

json_pack()

void minsky::Item::json_pack ( classdesc::json_pack_t &  j ) const

inlinevirtual

Reimplemented in minsky::ItemT< DataOp, Operation< minsky::OperationType::data > >, minsky::ItemT< GodleyIcon >, minsky::ItemT< Operation< T >, OperationBase >, minsky::ItemT< Sheet >, minsky::ItemT< Ravel, Operation< OperationType::ravel > >, minsky::ItemT< SwitchIcon, BottomRightResizerItem >, minsky::ItemT< PlotWidget >, minsky::ItemT< IntOp, Operation< minsky::OperationType::integrate > >, minsky::ItemT< Lock >, minsky::ItemT< Variable< T >, VariableBase >, minsky::ItemT< Group >, and minsky::ItemT< UserFunction, Operation< OperationType::userFunction > >.

Definition at line 337 of file item.h.

    {::json_pack(j,"",*this);}

left()

float minsky::Item::left

(

)

const

Definition at line 163 of file item.cc.

Referenced by contains(), minsky::LassoBox::intersects(), and width().

  {
    auto left=x();
    for (auto& p: corners())
      if (p.x()<left) left=p.x();
    return left;
  }

Here is the caller graph for this function:

moveTo()

void minsky::Item::moveTo	(	float	x,
		float	y
	)

Definition at line 256 of file item.cc.

References minsky::anonymous_namespace{userFunction.cc}::isfinite().

Referenced by minsky::Minsky::addIntegral(), minsky::VariableBase::draw(), minsky::layoutGroup(), minsky::PhillipsDiagram::mouseMove(), minsky::IntOp::resize(), minsky::Ravel::resize(), minsky::VariableBase::resize(), and minsky::Minsky::setDefinition().

  {
    // cowardly refuse to move to a nonsense coordinate
    if (!isfinite(x)||!isfinite(y)) return;
    if (auto g=group.lock())
      {
        const float invZ=1/zoomFactor();
        m_x=(x-g->x())*invZ;
        m_y=(y-g->y())*invZ;
      }
    else
      {
        m_x=x;
        m_y=y;
      }
    if (bookmark) adjustBookmark();
    assert(abs(x-this->x())<1 && abs(y-this->y())<1);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

onItem()

bool minsky::Item::onItem ( float  x, float  y  ) const

virtual

returns true if (x,y) is on the icon

Definition at line 242 of file item.cc.

References minsky::Rotate::x(), and minsky::Rotate::y().

  {
    const Rotate r(-rotation(),this->x(),this->y());
    return bb.contains(
                       (r.x(x,y)-this->x())/zoomFactor(),
                       (r.y(x,y)-this->y())/zoomFactor());
  }

Here is the call graph for this function:

onKeyPress()

virtual bool minsky::Item::onKeyPress ( int  keySym, const std::string &  utf8, int  state  )

inlinevirtual

respond to key press events

Returns

true if it needs to be rerendered

Reimplemented in minsky::VariableBase, minsky::GodleyIcon, minsky::Ravel, minsky::IntOp, and minsky::Sheet.

Definition at line 276 of file item.h.

    {return false;}

onMouseDown()

virtual void minsky::Item::onMouseDown ( float  x, float  y  )

inlinevirtual

respond to mouse down events

Reimplemented in minsky::GodleyIcon, and minsky::Ravel.

Definition at line 263 of file item.h.

{}

onMouseLeave()

virtual void minsky::Item::onMouseLeave ( )

inlinevirtual

respond to mouse leave events (when mouse leaves item)

Reimplemented in minsky::PlotWidget, minsky::GodleyIcon, and minsky::Ravel.

Definition at line 273 of file item.h.

{}

onMouseMotion()

virtual bool minsky::Item::onMouseMotion ( float  x, float  y  )

inlinevirtual

respond to mouse motion events with button pressed

Returns

true if it needs to be rerendered

Reimplemented in minsky::VariableBase, minsky::GodleyIcon, and minsky::Ravel.

Definition at line 268 of file item.h.

{return false;}

onMouseOver()

virtual bool minsky::Item::onMouseOver ( float  x, float  y  )

inlinevirtual

respond to mouse motion events (hover) without button pressed

Returns

true if it needs to be rerendered

Reimplemented in minsky::PlotWidget, minsky::GodleyIcon, and minsky::Ravel.

Definition at line 271 of file item.h.

{return false;}

onMouseUp()

virtual void minsky::Item::onMouseUp ( float  x, float  y  )

inlinevirtual

respond to mouse up events

Reimplemented in minsky::GodleyIcon, and minsky::Ravel.

Definition at line 265 of file item.h.

{}

onResizeHandle()

bool minsky::Item::onResizeHandle ( float  x, float  y  ) const

virtual

Returns

true is (x,y) is located on a resize handle

Reimplemented in minsky::BottomRightResizerItem, and minsky::Sheet.

Definition at line 228 of file item.cc.

References minsky::anonymous_namespace{item.cc}::near().

  {
    float rhSize=resizeHandleSize();
    auto cnrs=corners();
    return any_of(cnrs.begin(), cnrs.end(), [&](const Point& p)
                  {return near(x,y,p.x(),p.y(),rhSize);});
  }

Here is the call graph for this function:

operator=()

Item& minsky::Item::operator= ( const Item &  )

default

ports()

virtual std::weak_ptr<Port> minsky::Item::ports ( std::size_t  i ) const

inlinevirtual

callback to be run when item deleted from group

return a weak reference to the ith port

Reimplemented in minsky::IntOp.

Definition at line 180 of file item.h.

References m_ports.

Referenced by minsky::GroupItems::addWire(), schema3::IdMap::at(), minsky::anonymous_namespace{operation.cc}::CheckConsistent::CheckConsistent(), minsky::VariableBase::inputWired(), MathDAG::SubexpressionCache::key(), MathDAG::SystemOfEquations::makeDAG(), minsky::IntOp::ports(), portX(), portY(), minsky::Minsky::setDefinition(), and minsky::TensorsFromPort::tensorsFromPorts().

                                                       {
      return i<m_ports.size()? m_ports[i]: nullptr;
    }

Here is the caller graph for this function:

portsSize()

std::size_t minsky::Item::portsSize ( ) const

inline

number of ports

Definition at line 184 of file item.h.

References m_ports.

Referenced by minsky::GroupItems::addWire(), schema3::IdMap::at(), minsky::anonymous_namespace{operation.cc}::CheckConsistent::CheckConsistent(), and minsky::TensorsFromPort::tensorsFromPorts().

{return m_ports.size();}

Here is the caller graph for this function:

portX()

float minsky::Item::portX ( std::size_t  i )

inline

Definition at line 185 of file item.h.

References ports().

                             {
      if (auto p=ports(i).lock()) return p->x();
      return 0;
    }

Here is the call graph for this function:

portY()

float minsky::Item::portY ( std::size_t  i )

inline

Definition at line 190 of file item.h.

References ports().

                             {
      if (auto p=ports(i).lock()) return p->y();
      return 0;
    }

Here is the call graph for this function:

resize()

void minsky::Item::resize ( const LassoBox &  b )

virtual

resize this item on the canvas

Reimplemented in minsky::Group, minsky::VariableBase, minsky::PlotWidget, minsky::Ravel, minsky::GodleyIcon, minsky::OperationBase, and minsky::IntOp.

Definition at line 333 of file item.cc.

References f, minsky::LassoBox::x0, minsky::LassoBox::x1, minsky::LassoBox::y0, and minsky::LassoBox::y1.

  {
    // Set initial iWidth() and iHeight() to initial Pango determined values. This resize method is not very reliable. Probably a Pango issue. 
    const float w=iWidth(width()), h=iHeight(height()), invZ=1/zoomFactor();   
    moveTo(0.5*(b.x0+b.x1), 0.5*(b.y0+b.y1));                 
    iWidth(abs(b.x1-b.x0)*invZ);
    iHeight(abs(b.y1-b.y0)*invZ);     
    scaleFactor(std::max(1.0f,std::min(iWidth()/w,iHeight()/h)));
  }

resizeHandleSize()

float minsky::Item::resizeHandleSize ( ) const

inline

resize handles should be at least a percentage if the icon size (#1025)

Definition at line 255 of file item.h.

References f, height(), minsky::portRadius, width(), and zoomFactor().

Referenced by contains().

{return std::max(portRadius*zoomFactor(), std::max(0.02f*width(), 0.02f*height()));}

Here is the call graph for this function:

Here is the caller graph for this function:

RESTProcess() [1/2]

void minsky::Item::RESTProcess ( classdesc::RESTProcess_t &  rp, const std::string &  d  )

inlineoverride

runs the RESTProcess descriptor suitable for this type

dummy definition for use with gui executable

Definition at line 333 of file item.h.

Referenced by RESTProcess().

    {::RESTProcess(rp,d,*this);}

Here is the caller graph for this function:

RESTProcess() [2/2]

void minsky::Item::RESTProcess ( classdesc::RESTProcess_t &  rp, const std::string &  d  ) const

inlineoverride

Definition at line 335 of file item.h.

References RESTProcess().

    {::RESTProcess(rp,d,*this);}

Here is the call graph for this function:

right()

float minsky::Item::right

(

)

const

Definition at line 170 of file item.cc.

Referenced by minsky::LassoBox::intersects(), and width().

  {
    auto right=x();
    for (auto& p: corners())
      if (p.x()>right) right=p.x();
    return right;
  }

Here is the caller graph for this function:

rotation() [1/2]

double minsky::Item::rotation ( ) const

inline

Definition at line 211 of file item.h.

Referenced by minsky::VariableBase::clickType(), minsky::IntOp::draw(), minsky::VariableBase::draw(), flip(), minsky::RenderVariable::inImage(), minsky::VariableBase::onMouseMotion(), minsky::PhillipsStock::PhillipsStock(), schema3::populateItem(), minsky::IntOp::toggleCoupled(), and minsky::BoundingBox::update().

{return m_rotation;}

Here is the caller graph for this function:

rotation() [2/2]

double minsky::Item::rotation ( const double &  r )

inline

Definition at line 212 of file item.h.

{return m_rotation=r;}

rotationAsRadians()

std::pair< double, bool > minsky::Item::rotationAsRadians

(

)

const

return the rotation as radians, and whether rotation should have additional straight angle added for text that stays upright.

Definition at line 92 of file item.cc.

References minsky::flipped(), and M_PI.

Referenced by minsky::IntOp::draw(), and minsky::VariableBase::draw().

  {
    // if rotation is in 1st or 3rd quadrant, rotate as
    // normal, otherwise flip the text so it reads L->R
    return {rotation() * M_PI / 180.0, flipped(rotation())};
  }

Here is the call graph for this function:

Here is the caller graph for this function:

scaleFactor() [1/2]

float minsky::Item::scaleFactor ( ) const

virtual

factor by which item has been resized

Reimplemented in minsky::OperationBase.

Definition at line 128 of file item.cc.

Referenced by minsky::GodleyIcon::bottomMargin(), and minsky::GodleyIcon::leftMargin().

  { 
    return m_sf;
  }  

Here is the caller graph for this function:

scaleFactor() [2/2]

float minsky::Item::scaleFactor ( const float &  sf )

virtual

Definition at line 133 of file item.cc.

                                         {
    m_sf=sf;
    bb.update(*this);
    return m_sf;
  }   

select()

virtual std::shared_ptr<Item> minsky::Item::select ( float  x, float  y  ) const

inlinevirtual

returns the variable if point (x,y) is within a visible variable icon, null otherwise.

Reimplemented in minsky::Group, and minsky::GodleyIcon.

Definition at line 328 of file item.h.

{return {};}

TCL_obj()

virtual void minsky::Item::TCL_obj ( classdesc::TCL_obj_t &  t, const std::string &  d  )

inlinevirtual

runs the TCL_obj descriptor suitable for this type

Reimplemented in minsky::ItemT< DataOp, Operation< minsky::OperationType::data > >, minsky::ItemT< GodleyIcon >, minsky::ItemT< Operation< T >, OperationBase >, minsky::ItemT< Sheet >, minsky::ItemT< Ravel, Operation< OperationType::ravel > >, minsky::ItemT< SwitchIcon, BottomRightResizerItem >, minsky::ItemT< PlotWidget >, minsky::ItemT< IntOp, Operation< minsky::OperationType::integrate > >, minsky::ItemT< Lock >, minsky::ItemT< Variable< T >, VariableBase >, minsky::ItemT< Group >, and minsky::ItemT< UserFunction, Operation< OperationType::userFunction > >.

Definition at line 330 of file item.h.

    {::TCL_obj(t,d,*this);}

throw_error()

void minsky::Item::throw_error

(

const std::string &

msg

)

const

mark item on canvas, then throw

Definition at line 86 of file item.cc.

References minsky::cminsky(), and minsky::Minsky::displayErrorItem().

Referenced by MathDAG::LockDAG::addEvalOps(), minsky::anonymous_namespace{operation.cc}::CheckConsistent::CheckConsistent(), minsky::UserFunction::compile(), MathDAG::LockDAG::derivative(), minsky::VariableBase::importFromCSV(), minsky::VariableBase::units(), and units().

  {
    cminsky().displayErrorItem(*this);
    throw runtime_error(msg);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

toggleEditorMode()

virtual void minsky::Item::toggleEditorMode ( )

inlinevirtual

Reimplemented in minsky::Ravel, and minsky::GodleyIcon.

Definition at line 346 of file item.h.

{}

top()

float minsky::Item::top

(

)

const

Definition at line 177 of file item.cc.

Referenced by contains(), height(), and minsky::LassoBox::intersects().

  {
    auto top=y();
    for (auto& p: corners())
      if (p.y()<top) top=p.y();
    return top;
  }

Here is the caller graph for this function:

units()

virtual Units minsky::Item::units ( bool  check = false ) const

inlinevirtual

compute the dimensional units

Parameters

check

- if true, then perform consistency checks

Exceptions

if	check=true and dimensions inconsistent

Reimplemented in minsky::Ravel, minsky::VariableBase, minsky::OperationBase, minsky::Copy, minsky::Derivative, minsky::Time, minsky::IntOp, minsky::SwitchIcon, minsky::DataOp, minsky::UserFunction, and minsky::Lock.

Definition at line 352 of file item.h.

References throw_error().

Referenced by checkUnits().

                                                {
      if (check) throw_error("units not implemented");
      return {};
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateBoundingBox()

void minsky::Item::updateBoundingBox ( )

inlineoverridevirtual

Reimplemented from minsky::NoteBase.

Definition at line 201 of file item.h.

References bb, and minsky::BoundingBox::update().

Referenced by minsky::Ravel::applyState(), minsky::VariableBase::init(), and minsky::PhillipsStock::PhillipsStock().

{bb.update(*this);}

Here is the call graph for this function:

Here is the caller graph for this function:

updateIcon()

virtual void minsky::Item::updateIcon ( double  t )

inlinevirtual

update display after a step()

Reimplemented in minsky::PlotWidget.

Definition at line 309 of file item.h.

{}

value()

virtual double minsky::Item::value ( ) const

inlinevirtual

current value of output port

Reimplemented in minsky::VariableBase, minsky::OperationBase, and minsky::SwitchIcon.

Definition at line 209 of file item.h.

{return 0;}

visible()

bool minsky::Item::visible ( ) const

virtual

whether this item is visible on the canvas.

Reimplemented in minsky::VariableBase.

Definition at line 250 of file item.cc.

Referenced by minsky::VariableBase::visible().

  {
    auto g=group.lock();
    return (!g || g->displayContents());
  }

Here is the caller graph for this function:

width()

float minsky::Item::width ( ) const

inline

Definition at line 242 of file item.h.

References left(), and right().

Referenced by minsky::PhillipsStock::draw(), minsky::anonymous_namespace{autoLayout.cc}::minD(), resizeHandleSize(), minsky::Minsky::setDefinition(), and minsky::PlotWidget::width().

{return right()-left();}

Here is the call graph for this function:

Here is the caller graph for this function:

x()

float minsky::Item::x ( ) const

virtual

Definition at line 107 of file item.cc.

Referenced by minsky::Group::addBookmarkXY(), minsky::VariableBase::clickType(), minsky::VariableBase::detailedText(), minsky::Ravel::displayDelayedTooltip(), minsky::IntOp::draw(), minsky::PhillipsStock::draw(), minsky::Ravel::draw(), minsky::VariableBase::draw(), minsky::VariableBase::enableSlider(), minsky::RenderVariable::inImage(), minsky::VariableBase::init(), minsky::Ravel::inItem(), minsky::IntOp::IntOp(), minsky::Ravel::onMouseDown(), minsky::Ravel::onMouseMotion(), minsky::VariableBase::onMouseMotion(), minsky::Ravel::onMouseOver(), minsky::Ravel::onMouseUp(), minsky::anonymous_namespace{godleyIcon.cc}::DrawVars::operator()(), minsky::SwitchIcon::operator=(), minsky::IntOp::operator=(), minsky::Operation< minsky::OperationType::integrate >::operator=(), minsky::Variable< VariableType::constant >::operator=(), minsky::IntOp::pack(), minsky::Ravel::setDisplayFilterCaliper(), minsky::Ravel::setSortOrder(), minsky::VariableBase::setUnits(), minsky::VariableBase::sliderMax(), minsky::VariableBase::sliderMin(), minsky::VariableBase::sliderStep(), minsky::VariableBase::sliderStepRel(), minsky::SwitchIcon::SwitchIcon(), minsky::VariableBase::tooltip(), minsky::IntOp::unpack(), minsky::VariableBase::value(), minsky::VarConstant::value(), minsky::GodleyIcon::valueId(), and minsky::VariableInstanceList::VariableInstanceList().

  {
    if (auto g=group.lock()) 
      return zoomFactor()*m_x+g->x();
    return m_x;
  }

Here is the caller graph for this function:

y()

float minsky::Item::y ( ) const

virtual

Definition at line 114 of file item.cc.

Referenced by minsky::Group::addBookmarkXY(), minsky::VariableBase::clickType(), minsky::Ravel::displayDelayedTooltip(), minsky::IntOp::draw(), minsky::PhillipsStock::draw(), minsky::Ravel::draw(), minsky::VariableBase::draw(), minsky::RenderVariable::inImage(), minsky::Ravel::inItem(), minsky::Ravel::onMouseDown(), minsky::Ravel::onMouseMotion(), minsky::Ravel::onMouseOver(), minsky::Ravel::onMouseUp(), minsky::anonymous_namespace{godleyIcon.cc}::DrawVars::operator()(), and minsky::VariableInstanceList::VariableInstanceList().

  {
    if (auto g=group.lock())
      return zoomFactor()*m_y+g->y();
    return m_y;
  }

Here is the caller graph for this function:

zoomFactor()

float minsky::Item::zoomFactor ( ) const

virtual

Reimplemented in minsky::VariableBase.

Definition at line 121 of file item.cc.

Referenced by minsky::Group::addBookmarkXY(), minsky::GodleyIcon::bottomMargin(), minsky::Group::displayContents(), minsky::IntOp::draw(), minsky::Ravel::draw(), minsky::Group::edgeScale(), minsky::Ravel::inItem(), minsky::GodleyIcon::leftMargin(), minsky::Group::localZoom(), minsky::Ravel::onMouseDown(), minsky::Ravel::onMouseMotion(), minsky::Ravel::onMouseOver(), minsky::Ravel::onMouseUp(), minsky::IntOp::resize(), minsky::Ravel::resize(), resizeHandleSize(), minsky::GodleyIcon::titleOffs(), minsky::BoundingBox::update(), and minsky::VariableBase::zoomFactor().

  {
    if (auto g=group.lock())
      return g->zoomFactor()*g->relZoom;
    return 1;
  }

Here is the caller graph for this function:

Member Data Documentation

bb

BoundingBox minsky::Item::bb

mutable

canvas bounding box.

Definition at line 195 of file item.h.

Referenced by minsky::IntOp::description(), ensureBBValid(), iHeight(), iWidth(), minsky::VariableBase::name(), minsky::IntOp::resize(), minsky::Ravel::resize(), minsky::IntOp::toggleCoupled(), minsky::UserFunction::updateBB(), minsky::DataOp::updateBB(), minsky::GodleyIcon::updateBB(), and updateBoundingBox().

deleteCallback

std::string minsky::Item::deleteCallback

Definition at line 177 of file item.h.

Referenced by minsky::MinskyTCL::runItemDeletedCallback().

m_height

double minsky::Item::m_height =10

protected

Definition at line 155 of file item.h.

Referenced by iHeight().

m_ports

ItemPortVector minsky::Item::m_ports

protected

Definition at line 156 of file item.h.

Referenced by minsky::VariableBase::addPorts(), minsky::IntOp::draw(), minsky::PhillipsStock::draw(), minsky::Ravel::draw(), minsky::VariableBase::draw(), minsky::Ravel::exportAsCSV(), minsky::VariableBase::init(), minsky::SwitchIcon::numCases(), ports(), portsSize(), minsky::Ravel::sortByValue(), minsky::IntOp::toggleCoupled(), minsky::DataOp::units(), minsky::IntOp::units(), minsky::Copy::units(), minsky::VariableBase::units(), minsky::Ravel::units(), and minsky::SwitchIcon::value().

m_sf

float minsky::Item::m_sf =1

scale factor of item on canvas, or within group

Definition at line 174 of file item.h.

Referenced by schema3::populateItem().

m_width

double minsky::Item::m_width =10

protected

Definition at line 155 of file item.h.

Referenced by iWidth().

m_x

float minsky::Item::m_x =0

Definition at line 173 of file item.h.

Referenced by schema3::populateItem().

m_y

float minsky::Item::m_y =0

position in canvas, or within group

Definition at line 173 of file item.h.

Referenced by schema3::populateItem().

memoisedRotator

minsky::Item::MemoisedRotator minsky::Item::memoisedRotator

protected

onBorder

bool minsky::Item::onBorder =false

true to indicate mouse hovering over border

Definition at line 176 of file item.h.

Referenced by minsky::Ravel::draw().

onResizeHandles

bool minsky::Item::onResizeHandles =false

mutable

set to true to indicate mouse is ovcaler resize handles

Definition at line 175 of file item.h.

Referenced by minsky::IntOp::draw(), minsky::VariableBase::draw(), and minsky::BoundingBox::update().

---

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

• model/item.h
• model/item.cc
• gui-tk/itemTemplateInstantiations.cc