#include <switchIcon.h>

Inheritance diagram for minsky::SwitchIcon:

Collaboration diagram for minsky::SwitchIcon:

Public Member Functions
	SwitchIcon ()
	default to if/then More...

	SwitchIcon (const SwitchIcon &x)

	SwitchIcon (SwitchIcon &&x)

SwitchIcon &	operator= (const SwitchIcon &x)

SwitchIcon &	operator= (SwitchIcon &&x)

unsigned	switchValue () const
	value of switch according to current inputs More...

double	value () const override
	current value of output port More...

const SwitchIcon *	switchIconCast () const override

SwitchIcon *	switchIconCast () override

Units	units (bool) const override
	compute the dimensional units More...

void	draw (cairo_t *context) const override
	draw icon to context More...

void	flip () override
	rotate icon though 180∘ More...


unsigned	numCases () const

void	setNumCases (unsigned)

Public Member Functions inherited from minsky::ItemT< SwitchIcon, BottomRightResizerItem >
std::string	classType () const override

ItemT *	clone () const override

void	TCL_obj (classdesc::TCL_obj_t &t, const std::string &d) override

void	RESTProcess (classdesc::RESTProcess_t &rp, const std::string &d) override
	dummy template definition for use with gui executable More...

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

void	json_pack (classdesc::json_pack_t &j) const override

	ItemT ()=default

	ItemT (const ItemT &)=default

	ItemT (ItemT &&)=delete

ItemT &	operator= (const ItemT &)=default

ItemT &	operator= (ItemT &&)=delete

Public Member Functions inherited from minsky::BottomRightResizerItem
bool	onResizeHandle (float x, float y) const override

void	drawResizeHandles (cairo_t *cairo) const override

virtual Point	resizeHandleCoords () const
	returns coordinates of the resizer handle More...

Public Member Functions inherited from minsky::Item
	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...

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)

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	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 bool	visible () const
	whether this item is visible on the canvas. More...

void	moveTo (float x, float y)

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

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

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

Public Attributes
bool	flipped =false
	whether icon is oriented so input ports are on the rhs, and output on the lhs More...

Public Attributes inherited from minsky::Item
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...

Private Types
using	Super = ItemT< SwitchIcon, BottomRightResizerItem >

Private Member Functions
	CLASSDESC_ACCESS (SwitchIcon)

Friends
struct	SchemaHelper

Additional Inherited Members
Static Public Member Functions inherited from minsky::Item
static void	drawSelected (cairo_t *cairo)

Static Protected Member Functions inherited from minsky::Item
static void	drawResizeHandle (cairo_t *cairo, double x, double y, double sf, double angle)

Protected Attributes inherited from minsky::Item
double	m_width =10

double	m_height =10

ItemPortVector	m_ports

minsky::Item::MemoisedRotator	memoisedRotator

Detailed Description

Definition at line 27 of file switchIcon.h.

Member Typedef Documentation

◆ Super

using minsky::SwitchIcon::Super = ItemT<SwitchIcon, BottomRightResizerItem>

private

Definition at line 29 of file switchIcon.h.

Constructor & Destructor Documentation

◆ SwitchIcon() [1/3]

minsky::SwitchIcon::SwitchIcon ( )

inline

default to if/then

Definition at line 33 of file switchIcon.h.

References setNumCases().

Here is the call graph for this function:

◆ SwitchIcon() [2/3]

minsky::SwitchIcon::SwitchIcon ( const SwitchIcon & x )

inline

Definition at line 34 of file switchIcon.h.

References setNumCases(), and minsky::Item::x().

34 : Super(x), flipped(x.flipped) {setNumCases(x.numCases());}

minsky::SwitchIcon::setNumCases

void setNumCases(unsigned)

Definition: switchIcon.cc:31

minsky::Item::x

virtual float x() const

Definition: item.cc:107

minsky::SwitchIcon::Super

ItemT< SwitchIcon, BottomRightResizerItem > Super

Definition: switchIcon.h:29

minsky::SwitchIcon::flipped

bool flipped

whether icon is oriented so input ports are on the rhs, and output on the lhs

Definition: switchIcon.h:70

Here is the call graph for this function:

◆ SwitchIcon() [3/3]

minsky::SwitchIcon::SwitchIcon ( SwitchIcon && x )

inline

Definition at line 35 of file switchIcon.h.

References setNumCases(), and minsky::Item::x().

35 : Super(x), flipped(x.flipped) {setNumCases(x.numCases());}

minsky::SwitchIcon::setNumCases

void setNumCases(unsigned)

Definition: switchIcon.cc:31

minsky::Item::x

virtual float x() const

Definition: item.cc:107

minsky::SwitchIcon::Super

ItemT< SwitchIcon, BottomRightResizerItem > Super

Definition: switchIcon.h:29

minsky::SwitchIcon::flipped

bool flipped

whether icon is oriented so input ports are on the rhs, and output on the lhs

Definition: switchIcon.h:70

Here is the call graph for this function:

Member Function Documentation

◆ CLASSDESC_ACCESS()

minsky::SwitchIcon::CLASSDESC_ACCESS ( SwitchIcon )

private

◆ draw()

void minsky::SwitchIcon::draw ( cairo_t * context ) const

overridevirtual

draw icon to context

Reimplemented from minsky::Item.

Definition at line 75 of file switchIcon.cc.

References minsky::drawTriangle(), minsky::flipped(), and M_PI.

   {
     auto z=zoomFactor();
     // following the draw method in the Sheet class, iWidth() and iHeight() have been changed to m_width and m_height,
     // since the former largely play a role in the VariableBase and OperationBase classes. for ticket 1250
     const float width=m_width*z, height=m_height*z;
     cairo_set_line_width(cairo,1);
     cairo_rectangle(cairo,-0.5*width,-0.5*height,width,height);
     cairo_stroke(cairo);         
 
     const float w=flipped? -width: width;
     const float o=flipped? -8: 8;
     // output port
     drawTriangle(cairo, 0.5*w, 0, palette[0], flipped? M_PI: 0);
     m_ports[0]->moveTo(x()+0.5*w, y());
     // control port
     drawTriangle(cairo, 0, -0.5*height-8, palette[0], M_PI/2);
     m_ports[1]->moveTo(x(), y()-0.5*height-8);
     const float dy=height/numCases();
     float y1=-0.5*height+0.5*dy;
     // case ports
     for (size_t i=2; i<m_ports.size(); ++i, y1+=dy)
       {
         drawTriangle(cairo, -0.5*w-o, y1, palette[(i-2)%paletteSz], flipped? M_PI: 0);
         m_ports[i]->moveTo(x()+-0.5*w-o, y()+y1);
       }
     // draw indicating arrow
     cairo_move_to(cairo,0.5*w, 0);
     try
       {
         y1=-0.5*width+0.5*dy+switchValue()*dy;
       }
     catch (const std::exception&)
       {
         y1=-0.5*width+0.5*dy;
       }
     cairo_line_to(cairo,-0.45*w,0.9*y1);
     cairo_stroke(cairo);
 
     if (mouseFocus)
       {                   
         drawPorts(cairo);
         displayTooltip(cairo,tooltip());
         if (onResizeHandles) drawResizeHandles(cairo);
       }        
 
     // add 8 pt margin to allow for ports
     cairo_rectangle(cairo,-0.5*width-8,-0.5*height-8,width+16,height+8);
     cairo_clip(cairo);
     if (selected) drawSelected(cairo);
   }

Here is the call graph for this function:

◆ flip()

void minsky::SwitchIcon::flip ( )

inlineoverridevirtual

rotate icon though 180∘

Reimplemented from minsky::Item.

Definition at line 71 of file switchIcon.h.

References flipped.

71 {flipped=!flipped;}

minsky::SwitchIcon::flipped

bool flipped

whether icon is oriented so input ports are on the rhs, and output on the lhs

Definition: switchIcon.h:70

◆ numCases()

unsigned minsky::SwitchIcon::numCases ( ) const

inline

number of cases switched between. If input <1, case 0 is chosen, if input >=numCases-1, case numCases-1 is chosen

Definition at line 53 of file switchIcon.h.

References minsky::Item::m_ports.

53 {return m_ports.size()-2;}

minsky::Item::m_ports

ItemPortVector m_ports

Definition: item.h:156

◆ operator=() [1/2]

SwitchIcon& minsky::SwitchIcon::operator= ( const SwitchIcon & x )

inline

Definition at line 36 of file switchIcon.h.

References flipped, minsky::ItemT< SwitchIcon, BottomRightResizerItem >::operator=(), setNumCases(), and minsky::Item::x().

                                                {
       Super::operator=(x);
       flipped=x.flipped;
       setNumCases(x.numCases());
       return *this;
     }

Here is the call graph for this function:

◆ operator=() [2/2]

SwitchIcon& minsky::SwitchIcon::operator= ( SwitchIcon && x )

inline

Definition at line 42 of file switchIcon.h.

References flipped, minsky::ItemT< SwitchIcon, BottomRightResizerItem >::operator=(), setNumCases(), and minsky::Item::x().

                                           {
       Super::operator=(x);
       flipped=x.flipped;
       setNumCases(x.numCases());
       return *this;
     }

Here is the call graph for this function:

◆ setNumCases()

void minsky::SwitchIcon::setNumCases ( unsigned n )

number of cases switched between. If input <1, case 0 is chosen, if input >=numCases-1, case numCases-1 is chosen

Definition at line 31 of file switchIcon.cc.

Referenced by operator=(), and SwitchIcon().

   {
     if (n<2) throw error("switches need at least two cases");
 
     m_ports.clear();
     m_ports.emplace_back(make_shared<Port>(*this));
     // output port, selector port and n case ports
     for (unsigned i=m_ports.size(); i<n+2; ++i)
       m_ports.emplace_back(make_shared<InputPort>(*this));
     const float width=8*numCases();
     if (width>iWidth()) iWidth(width);
     if (width>iHeight()) iHeight(width);
   }

Here is the caller graph for this function:

◆ switchIconCast() [1/2]

const SwitchIcon* minsky::SwitchIcon::switchIconCast ( ) const

inlineoverride

Definition at line 61 of file switchIcon.h.

61 {return this;}

◆ switchIconCast() [2/2]

SwitchIcon* minsky::SwitchIcon::switchIconCast ( )

inlineoverride

Definition at line 62 of file switchIcon.h.

62 {return this;}

◆ switchValue()

unsigned minsky::SwitchIcon::switchValue ( ) const

value of switch according to current inputs

Definition at line 45 of file switchIcon.cc.

Referenced by value().

   {
     const double x=m_ports[1]->value();
     if (x<1)
       return 0;
     if (x>=numCases()-1)
       return numCases()-1;
     return unsigned(x);
   }

Here is the caller graph for this function:

◆ units()

Units minsky::SwitchIcon::units ( bool check ) const

overridevirtual

compute the dimensional units

Parameters

check - if true, then perform consistency checks

Exceptions

if	check=true and dimensions inconsistent

Reimplemented from minsky::Item.

Definition at line 55 of file switchIcon.cc.

References minsky::Units::str().

   {
     bool inputFound=false;
     Units r;
     for (size_t i=2; i<m_ports.size(); ++i)
       for (auto w: m_ports[i]->wires())
         if (check && inputFound)
           {
             auto tmp=w->units(check);
             if (tmp!=r)
               throw_error("incompatible units: "+tmp.str()+"≠"+r.str());
           }
         else
           {
             inputFound=true;
             r=w->units(check);
           }
     return r;
   } 

Here is the call graph for this function:

◆ value()

double minsky::SwitchIcon::value ( ) const

inlineoverridevirtual

current value of output port

Reimplemented from minsky::Item.

Definition at line 59 of file switchIcon.h.

References minsky::Item::m_ports, and switchValue().

59 {return m_ports[switchValue()+2]->value();}

minsky::SwitchIcon::switchValue

unsigned switchValue() const

value of switch according to current inputs

Definition: switchIcon.cc:45

minsky::Item::m_ports

ItemPortVector m_ports

Definition: item.h:156

Here is the call graph for this function:

Friends And Related Function Documentation

◆ SchemaHelper

friend struct SchemaHelper

friend

Definition at line 31 of file switchIcon.h.

Member Data Documentation

◆ flipped

bool minsky::SwitchIcon::flipped =false

whether icon is oriented so input ports are on the rhs, and output on the lhs

Definition at line 70 of file switchIcon.h.

Referenced by flip(), and operator=().

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

model/switchIcon.h
model/switchIcon.cc

Public Member Functions

Public Attributes

Private Types

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Super

Constructor & Destructor Documentation

◆ SwitchIcon() [1/3]

◆ SwitchIcon() [2/3]

◆ SwitchIcon() [3/3]

Member Function Documentation

◆ CLASSDESC_ACCESS()

◆ draw()

◆ flip()

◆ numCases()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setNumCases()

◆ switchIconCast() [1/2]

◆ switchIconCast() [2/2]

◆ switchValue()

◆ units()

◆ value()

Friends And Related Function Documentation

◆ SchemaHelper

Member Data Documentation

◆ flipped