Base class of all elements of the program. This class is responsible for manage graphical and his data. More...

#include <Element.h>

Inheritance diagram for Element:

Public Member Functions
	Element ()
	Constructor.

virtual	~Element ()
	Destructor.

void	SetDragging (bool dragging=true)
	Set if the element are being dragged. More...

void	SetHeight (double height)
	Set element height. More...

void	SetPosition (const wxPoint2DDouble position)
	Set the element position and update the rectangle. More...

void	SetSelected (bool selected=true)
	Set element selection. More...

void	SetWidth (double width)
	Set element width. More...

void	SetAngle (double angle)
	Set element angle. More...

void	ShowPickbox (bool showPickbox=true)
	Set if the pickbox is shown. More...

void	SetBorderSize (double borderSize)
	Set the size of the border (shown in selected elements). More...

bool	SetOnline (bool online=true)
	Set if the element is online or offline. More...

virtual void	SetPointList (std::vector< wxPoint2DDouble > pointList)
	Set the list of points that connect the element to the bus. More...

wxRect2DDouble	GetRect () const
	Get the element rectangle. More...

wxPoint2DDouble	GetPosition () const
	Get the element position. More...

bool	IsDragging () const
	Checks if the element is being dragged. More...

double	GetHeight () const
	Get the element height. More...

bool	IsSelected () const
	Checks if the element is selected. More...

double	GetWidth () const
	Get the element width. More...

double	GetAngle () const
	Get the element angle. More...

double	GetRotationAngle () const
	Get the angle of rotation. More...

bool	IsPickboxShown () const
	Checks if the pickbox is shown. More...

bool	IsOnline () const
	Checks if the element is online or offline. More...

virtual std::vector< wxPoint2DDouble >	GetPointList () const
	Get the list of points that connect the element to bus. More...

virtual bool	AddParent (Element *parent, wxPoint2DDouble position)
	Add a parent to the element. This method must be used on power elements that connect to a bus, so the parent must be a bus. The element basic points are calculated in this method, so apply this when the element is being inserted. More...

virtual void	AddParent (Element *parent)
	Add a parent to the element. More...

virtual bool	Contains (wxPoint2DDouble position) const =0
	Checks if the element contains a position. More...

virtual bool	Intersects (wxRect2DDouble rect) const =0
	Check if the element's rect intersects other rect. More...

virtual Element *	GetCopy ()
	Get a the element copy. More...

virtual void	SetID (int id)
	Set the element ID. More...

virtual int	GetID () const
	Get the element ID. More...

virtual void	AddChild (Element *child)
	Add a child to the child list. More...

virtual void	RemoveChild (Element *child)
	Remove a child from the list. More...

virtual void	ReplaceChild (Element oldChild, Element newChild)
	Replace a child from the list. More...

virtual wxString	GetTipText () const
	Get the tip text. More...

virtual void	Draw (wxPoint2DDouble translation, double scale) const
	Draw the element. More...

virtual void	Rotate (bool clockwise=true)
	Rotate the element. More...

virtual bool	GetContextMenu (wxMenu &menu)
	Get the element contex menu. More...

virtual void	AddPoint (wxPoint2DDouble point)
	Add point to the list of points that connect the element to the bus. More...

virtual void	StartMove (wxPoint2DDouble position)
	Update the element attributes related to the movement. More...

virtual void	Move (wxPoint2DDouble position)
	Move the element other position. More...

virtual void	MoveNode (Element *parent, wxPoint2DDouble position)
	Move a node. StartMove(wxPoint2DDouble position) before start moving. More...

virtual bool	NodeContains (wxPoint2DDouble position)
	Check if a node contains a point. If contains, set the attributes related to node movement. More...

virtual void	UpdateNodes ()
	Update the nodes according to the parents. If a parent is removed, use this method.

virtual bool	SetNodeParent (Element *parent)
	Set a perent to the node. If all conditions are met, a new parent are added to the element and the points related to the nodes will be calculated. More...

virtual void	RemoveParent (Element *parent)
	Remove a parent. More...

virtual void	ReplaceParent (Element oldParent, Element newParent)
	Replace a parent. More...

virtual void	RotateNode (Element *parent, bool clockwise=true)
	Rotate a node. More...

virtual bool	PickboxContains (wxPoint2DDouble position)
	Check if a pickbox contains a point. If contains the attributes related to pickbox movement will be calculated. More...

virtual void	MovePickbox (wxPoint2DDouble position)
	Move the pickbox. More...

virtual wxCursor	GetBestPickboxCursor () const
	Get the best cursor to shown to the user when the mouse is above a pickbox. More...

virtual void	ResetPickboxes ()
	Remove the pickboxes.

virtual void	ResetNodes ()
	Remove the active nodes.

virtual wxPoint2DDouble	WorldToScreen (wxPoint2DDouble translation, double scale, double offsetX=0.0, double offsetY=0.0) const
	Convert the element position to screen position. More...

virtual wxPoint2DDouble	WorldToScreen (wxPoint2DDouble position, wxPoint2DDouble translation, double scale, double offsetX=0.0, double offsetY=0.0) const
	Convert a generic position to screen position. More...

virtual bool	RotatedRectanglesIntersects (wxRect2DDouble rect1, wxRect2DDouble rect2, double angle1, double angle2) const
	Check if two roteted rectangles intersect. More...

virtual void	DrawCircle (wxPoint2DDouble position, double radius, int numSegments, GLenum mode=GL_LINE_LOOP) const
	Draw a circle. More...

virtual void	DrawArc (wxPoint2DDouble position, double radius, double initAngle, double finalAngle, int numSegments, GLenum mode=GL_LINE_LOOP) const

virtual void	DrawRectangle (wxPoint2DDouble position, double width, double height, GLenum mode=GL_QUADS) const
	Draw rectangle. More...

virtual void	DrawRectangle (wxPoint2DDouble *points, GLenum mode=GL_QUADS) const
	Draw rectangle. More...

virtual void	DrawTriangle (std::vector< wxPoint2DDouble > points, GLenum mode=GL_TRIANGLES) const
	Draw a triangle. More...

virtual void	DrawPoint (wxPoint2DDouble position, double size) const
	Draw a point. More...

virtual void	DrawLine (std::vector< wxPoint2DDouble > points, GLenum mode=GL_LINE_STRIP) const
	Draw line. More...

virtual void	DrawPickbox (wxPoint2DDouble position) const
	Draw pickbox. More...

virtual wxPoint2DDouble	RotateAtPosition (wxPoint2DDouble pointToRotate, double angle, bool degrees=true) const
	Rotate a point as element position being the origin. More...

virtual std::vector< Element * >	GetParentList () const
	Get the parent list. More...

virtual std::vector< Element * >	GetChildList () const
	Get the Child list. More...

virtual void	CalculateBoundaries (wxPoint2DDouble &leftUp, wxPoint2DDouble &rightBottom) const
	Calculate the element boundaries. More...

virtual void	GeneralMenuItens (wxMenu &menu)
	Insert general itens to context menu. More...

virtual bool	ShowForm (wxWindow parent, Element element)
	Show element data form. More...

virtual double	PointToLineDistance (wxPoint2DDouble point, int *segmentNumber=NULL) const
	Calculate the distance between a line (formed by point list) and a point. More...

Static Public Member Functions
static bool	DoubleFromString (wxWindow *parent, wxString strValue, double &value, wxString errorMsg)
	Get a double value from a string. Show a error message if the conversion fail. More...

static bool	IntFromString (wxWindow *parent, wxString strValue, int &value, wxString errorMsg)
	Convert a string to int. Show a error message if the conversion fail. More...

static wxString	StringFromDouble (double value, int minDecimal=1)
	Convert a double value to string. More...

Protected Attributes
int	m_elementID = 0

std::vector< Element * >	m_parentList

std::vector< Element * >	m_childList

wxRect2DDouble	m_rect

wxPoint2DDouble	m_position

double	m_width = 0.0

double	m_height = 0.0

double	m_angle = 0.0

double	m_borderSize = 2.0

double	m_rotationAngle = 45.0

double	m_switchSize = 10.0

std::vector< wxRect2DDouble >	m_switchRect

bool	m_selected = false

bool	m_dragging = false

bool	m_showPickbox = false

int	m_activePickboxID = ID_PB_NONE

int	m_activeNodeID = 0

std::vector< wxPoint2DDouble >	m_pointList

std::vector< wxPoint2DDouble >	m_movePts

wxPoint2DDouble	m_moveStartPt

wxPoint2DDouble	m_movePos

bool	m_online = true

OpenGLColour	m_selectionColour

Detailed Description

Base class of all elements of the program. This class is responsible for manage graphical and his data.

Author: Thales Lima Oliveira thale.nosp@m.s@uf.nosp@m.u.br

Date: 19/09/2017

Definition at line 113 of file Element.h.

Member Function Documentation

◆ AddChild()

void Element::AddChild ( Element * child )

virtual

Add a child to the child list.

Parameters

child New child.

Definition at line 353 of file Element.cpp.

◆ AddParent() [1/2]

virtual bool Element::AddParent	(	Element *	parent,
		wxPoint2DDouble	position
	)

inlinevirtual

Add a parent to the element. This method must be used on power elements that connect to a bus, so the parent must be a bus. The element basic points are calculated in this method, so apply this when the element is being inserted.

Parameters

parent	Element parent.
position	Node position in the parent.

Reimplemented in Transformer, Text, Load, Bus, Line, Capacitor, Inductor, and Machines.

Definition at line 240 of file Element.h.

◆ AddParent() [2/2]

virtual void Element::AddParent ( Element * parent )

inlinevirtual

Add a parent to the element.

Parameters

parent Element parent.

Definition at line 245 of file Element.h.

◆ AddPoint()

virtual void Element::AddPoint ( wxPoint2DDouble point )

inlinevirtual

Add point to the list of points that connect the element to the bus.

Parameters

point Point to be added.

Reimplemented in Line, and Branch.

Definition at line 318 of file Element.h.

◆ CalculateBoundaries()

void Element::CalculateBoundaries	(	wxPoint2DDouble &	leftUp,
		wxPoint2DDouble &	rightBottom
	)		const

virtual

Calculate the element boundaries.

Parameters

leftUp	Top-left position of the element.
rightBottom	Bottom-right position of the element.

Reimplemented in Line.

Definition at line 263 of file Element.cpp.

◆ Contains()

virtual bool Element::Contains ( wxPoint2DDouble position ) const

pure virtual

Checks if the element contains a position.

Parameters

position Position to be checked.

Implemented in Transformer, Text, Bus, Line, IOControl, TransferFunction, Capacitor, Inductor, Constant, Gain, Machines, Sum, MathOperation, ConnectionLine, Exponential, Limiter, RateLimiter, Branch, and Shunt.

◆ DoubleFromString()

bool Element::DoubleFromString	(	wxWindow *	parent,
		wxString	strValue,
		double &	value,
		wxString	errorMsg
	)

static

Get a double value from a string. Show a error message if the conversion fail.

Parameters

parent	Message box parent.
strValue	String value to be converted.
value	Double value converted.
errorMsg	Error message.

Definition at line 292 of file Element.cpp.

◆ Draw()

virtual void Element::Draw	(	wxPoint2DDouble	translation,
		double	scale
	)		const

inlinevirtual

Draw the element.

Parameters

translation	Translation of the system.
scale	Scale of the system.

Reimplemented in Transformer, Load, Bus, Line, IOControl, TransferFunction, Capacitor, Inductor, Machines, Constant, Gain, Sum, Branch, ConnectionLine, Exponential, Limiter, MathOperation, and RateLimiter.

Definition at line 302 of file Element.h.

◆ DrawCircle()

void Element::DrawCircle	(	wxPoint2DDouble	position,
		double	radius,
		int	numSegments,
		GLenum	mode = `GL_LINE_LOOP`
	)		const

virtual

Draw a circle.

Parameters

position	Circle position.
radius	Circle radius
numSegments	Num of segments of the circle.
mode	OpenGl primitive.

Definition at line 33 of file Element.cpp.

◆ DrawLine()

void Element::DrawLine	(	std::vector< wxPoint2DDouble >	points,
		GLenum	mode = `GL_LINE_STRIP`
	)		const

virtual

Draw line.

Parameters

points	Line vertices.
mode	OpenGl primitive.

Definition at line 89 of file Element.cpp.

◆ DrawPickbox()

void Element::DrawPickbox ( wxPoint2DDouble position ) const

virtual

Draw pickbox.

Parameters

position Pickbox position.

Definition at line 98 of file Element.cpp.

◆ DrawPoint()

void Element::DrawPoint	(	wxPoint2DDouble	position,
		double	size
	)		const

virtual

Draw a point.

Parameters

position	Point position.
size	Point size.

Definition at line 139 of file Element.cpp.

◆ DrawRectangle() [1/2]

void Element::DrawRectangle	(	wxPoint2DDouble	position,
		double	width,
		double	height,
		GLenum	mode = `GL_QUADS`
	)		const

virtual

Draw rectangle.

Parameters

position	Rectangle position.
width	Rectangle width.
height	Rectangle height.
mode	OpenGl primitive.

Definition at line 69 of file Element.cpp.

◆ DrawRectangle() [2/2]

void Element::DrawRectangle	(	wxPoint2DDouble *	points,
		GLenum	mode = `GL_QUADS`
	)		const

virtual

Draw rectangle.

Parameters

points	Rectangle vertices.
mode	OpenGl primitive.

Definition at line 79 of file Element.cpp.

◆ DrawTriangle()

void Element::DrawTriangle	(	std::vector< wxPoint2DDouble >	points,
		GLenum	mode = `GL_TRIANGLES`
	)		const

virtual

Draw a triangle.

Parameters

points	Triangle vertices.
mode	OpenGl primitive.

Definition at line 60 of file Element.cpp.

◆ GeneralMenuItens()

void Element::GeneralMenuItens ( wxMenu & menu )

virtual

Insert general itens to context menu.

Parameters

menu	Menu that will be inserted the general itens.

Definition at line 245 of file Element.cpp.

◆ GetAngle()

double Element::GetAngle ( ) const

inline

Get the element angle.

Returns: Angle value.

Definition at line 212 of file Element.h.

◆ GetBestPickboxCursor()

virtual wxCursor Element::GetBestPickboxCursor ( ) const

inlinevirtual

Get the best cursor to shown to the user when the mouse is above a pickbox.

Returns: Cursor.

Reimplemented in Bus, Line, and Branch.

Definition at line 389 of file Element.h.

◆ GetChildList()

virtual std::vector<Element*> Element::GetChildList ( ) const

inlinevirtual

Get the Child list.

Returns: Child List.

Definition at line 511 of file Element.h.

◆ GetContextMenu()

virtual bool Element::GetContextMenu ( wxMenu & menu )

inlinevirtual

Get the element contex menu.

Parameters

menu	menu that will be inserted the element itens.

Returns: True if was possible to build the menu, false otherwise.

Reimplemented in SyncGenerator, SyncMotor, Transformer, Bus, Load, Line, Branch, Capacitor, Inductor, and IndMotor.

Definition at line 313 of file Element.h.

◆ GetCopy()

virtual Element* Element::GetCopy ( )

inlinevirtual

Get a the element copy.

Returns: Copy of the element.

Reimplemented in SyncGenerator, SyncMotor, Transformer, Text, Load, TransferFunction, Bus, Line, IOControl, RateLimiter, Gain, ConnectionLine, Exponential, Sum, Constant, Limiter, IndMotor, Capacitor, Inductor, Divider, and Multiplier.

Definition at line 262 of file Element.h.

◆ GetHeight()

double Element::GetHeight ( ) const

inline

Get the element height.

Returns: Element height.

Definition at line 197 of file Element.h.

◆ GetID()

virtual int Element::GetID ( ) const

inlinevirtual

Get the element ID.

Returns: Element ID.

Definition at line 272 of file Element.h.

◆ GetParentList()

virtual std::vector<Element*> Element::GetParentList ( ) const

inlinevirtual

Get the parent list.

Returns: Parent list.

Definition at line 506 of file Element.h.

◆ GetPointList()

virtual std::vector<wxPoint2DDouble> Element::GetPointList ( ) const

inlinevirtual

Get the list of points that connect the element to bus.

Returns: List of points.

Definition at line 232 of file Element.h.

◆ GetPosition()

wxPoint2DDouble Element::GetPosition ( ) const

inline

Get the element position.

Returns: Element position.

Definition at line 187 of file Element.h.

◆ GetRect()

wxRect2DDouble Element::GetRect ( ) const

inline

Get the element rectangle.

Returns: Element rectangle.

Definition at line 182 of file Element.h.

◆ GetRotationAngle()

double Element::GetRotationAngle ( ) const

inline

Get the angle of rotation.

Returns: Rotation angle.

Definition at line 217 of file Element.h.

◆ GetTipText()

virtual wxString Element::GetTipText ( ) const

inlinevirtual

Get the tip text.

Returns: Tip text.

Reimplemented in SyncGenerator, SyncMotor, Transformer, Bus, Load, Line, Capacitor, Inductor, and IndMotor.

Definition at line 296 of file Element.h.

◆ GetWidth()

double Element::GetWidth ( ) const

inline

Get the element width.

Returns: Element width.

Definition at line 207 of file Element.h.

◆ Intersects()

virtual bool Element::Intersects ( wxRect2DDouble rect ) const

pure virtual

Check if the element's rect intersects other rect.

Parameters

rect	Rect to check intersection.

Implemented in Transformer, Text, Bus, Line, IOControl, TransferFunction, Capacitor, Inductor, Branch, Machines, Constant, Gain, Sum, MathOperation, ConnectionLine, Exponential, Limiter, RateLimiter, and Shunt.

◆ IntFromString()

bool Element::IntFromString	(	wxWindow *	parent,
		wxString	strValue,
		int &	value,
		wxString	errorMsg
	)

static

Convert a string to int. Show a error message if the conversion fail.

Parameters

parent	Message box parent.
strValue	String value to be converted.
value	Int value converted.
errorMsg	Error message.

Definition at line 306 of file Element.cpp.

◆ IsDragging()

bool Element::IsDragging ( ) const

inline

Checks if the element is being dragged.

Returns: True if is being dragged, false otherwise.

Definition at line 192 of file Element.h.

◆ IsOnline()

bool Element::IsOnline ( ) const

inline

Checks if the element is online or offline.

Returns: True if online, false if offline.

Definition at line 227 of file Element.h.

◆ IsPickboxShown()

bool Element::IsPickboxShown ( ) const

inline

Checks if the pickbox is shown.

Returns: True if the pickbox is show, false otherwise.

Definition at line 222 of file Element.h.

◆ IsSelected()

bool Element::IsSelected ( ) const

inline

Checks if the element is selected.

Returns: True if selected, false otherwise.

Definition at line 202 of file Element.h.

◆ Move()

void Element::Move ( wxPoint2DDouble position )

virtual

Move the element other position.

Parameters

position Position that the element will be moved. Use StartMove(wxPoint2DDouble position) before start moving.

Reimplemented in ControlElement, Transformer, Line, Gain, Machines, ConnectionLine, Branch, and Shunt.

Definition at line 123 of file Element.cpp.

◆ MoveNode()

virtual void Element::MoveNode	(	Element *	parent,
		wxPoint2DDouble	position
	)

inlinevirtual

Move a node. StartMove(wxPoint2DDouble position) before start moving.

Parameters

parent	Node's parent.
position	New node position.

Reimplemented in Transformer, Line, Machines, Branch, and Shunt.

Definition at line 337 of file Element.h.

◆ MovePickbox()

virtual void Element::MovePickbox ( wxPoint2DDouble position )

inlinevirtual

Move the pickbox.

Parameters

position position that the pickbox will be moved.

Reimplemented in Bus, Line, and Branch.

Definition at line 384 of file Element.h.

◆ NodeContains()

virtual bool Element::NodeContains ( wxPoint2DDouble position )

inlinevirtual

Check if a node contains a point. If contains, set the attributes related to node movement.

Parameters

position Position tested.

Returns: True if at least one node contains the position, false otherwise.

Reimplemented in Machines, Shunt, and Branch.

Definition at line 343 of file Element.h.

◆ PickboxContains()

virtual bool Element::PickboxContains ( wxPoint2DDouble position )

inlinevirtual

Check if a pickbox contains a point. If contains the attributes related to pickbox movement will be calculated.

Parameters

position Position to be checked.

Returns: True if the element constains the pickbox, false otherwise.

Reimplemented in Bus, Line, and Branch.

Definition at line 379 of file Element.h.

◆ PointToLineDistance()

double Element::PointToLineDistance	(	wxPoint2DDouble	point,
		int *	segmentNumber = `NULL`
	)		const

virtual

Calculate the distance between a line (formed by point list) and a point.

Parameters

point	origin point.
segmentNumber	Sotores the segment number clicked

Returns: The distance between the point and the line.

Definition at line 383 of file Element.cpp.

◆ RemoveChild()

void Element::RemoveChild ( Element * child )

virtual

Remove a child from the list.

Parameters

child Child to remove.

Definition at line 354 of file Element.cpp.

◆ RemoveParent()

virtual void Element::RemoveParent ( Element * parent )

inlinevirtual

Remove a parent.

Parameters

parent Parent to be removed.

Reimplemented in Machines, Branch, Shunt, and ConnectionLine.

Definition at line 359 of file Element.h.

◆ ReplaceChild()

void Element::ReplaceChild	(	Element *	oldChild,
		Element *	newChild
	)

virtual

Replace a child from the list.

Parameters

oldChild	Old child.
newChild	New child.

Definition at line 362 of file Element.cpp.

◆ ReplaceParent()

void Element::ReplaceParent	(	Element *	oldParent,
		Element *	newParent
	)

virtual

Replace a parent.

Parameters

oldParent	Parent to be replaced.
newParent	New parent.

Definition at line 346 of file Element.cpp.

◆ Rotate()

virtual void Element::Rotate ( bool clockwise = true )

inlinevirtual

Rotate the element.

Parameters

clockwise True to rotate clockwise, false to rotate counter-clockwise.

Reimplemented in Transformer, Text, Load, Bus, IOControl, Machines, TransferFunction, Capacitor, Inductor, Constant, Gain, Sum, MathOperation, Exponential, Limiter, and RateLimiter.

Definition at line 307 of file Element.h.

◆ RotateAtPosition()

wxPoint2DDouble Element::RotateAtPosition	(	wxPoint2DDouble	pointToRotate,
		double	angle,
		bool	degrees = `true`
	)		const

virtual

Rotate a point as element position being the origin.

Parameters

pointToRotate	Point that will be rotated.
angle	Angle of rotation.
degrees	True if the angle is in degrees, false if radians.

Definition at line 107 of file Element.cpp.

◆ RotatedRectanglesIntersects()

bool Element::RotatedRectanglesIntersects	(	wxRect2DDouble	rect1,
		wxRect2DDouble	rect2,
		double	angle1,
		double	angle2
	)		const

virtual

Check if two roteted rectangles intersect.

Parameters

rect1	First rect.
rect2	Second rect.
angle1	Rotation algle of first rectangle.
angle2	Rotation angle of second rectangle.

Definition at line 147 of file Element.cpp.

◆ RotateNode()

virtual void Element::RotateNode	(	Element *	parent,
		bool	clockwise = `true`
	)

inlinevirtual

Rotate a node.

Parameters

parent	Node's parent.
clockwise	True to rotate clockwise, false to rotate counter-clockwise.

Reimplemented in Transformer, Line, Branch, Machines, and Shunt.

Definition at line 372 of file Element.h.

◆ SetAngle()

void Element::SetAngle ( double angle )

inline

Set element angle.

Parameters

angle Angle value in degrees.

Definition at line 156 of file Element.h.

◆ SetBorderSize()

void Element::SetBorderSize ( double borderSize )

inline

Set the size of the border (shown in selected elements).

Parameters

borderSize Border size.

Definition at line 166 of file Element.h.

◆ SetDragging()

void Element::SetDragging ( bool dragging = true )

inline

Set if the element are being dragged.

Parameters

dragging True if is dragging, false otherwise.

Definition at line 130 of file Element.h.

◆ SetHeight()

void Element::SetHeight ( double height )

inline

Set element height.

Parameters

height Height value.

Definition at line 135 of file Element.h.

◆ SetID()

virtual void Element::SetID ( int id )

inlinevirtual

Set the element ID.

Parameters

id	Element ID.

Definition at line 267 of file Element.h.

◆ SetNodeParent()

virtual bool Element::SetNodeParent ( Element * parent )

inlinevirtual

Set a perent to the node. If all conditions are met, a new parent are added to the element and the points related to the nodes will be calculated.

Parameters

parent Node parent.

Returns: True if was possible to set the parent.

Reimplemented in Transformer, Line, Machines, Shunt, and Branch.

Definition at line 354 of file Element.h.

◆ SetOnline()

bool Element::SetOnline ( bool online = true )

Set if the element is online or offline.

Parameters

online True if online, false if offline.

Definition at line 235 of file Element.cpp.

◆ SetPointList()

virtual void Element::SetPointList ( std::vector< wxPoint2DDouble > pointList )

inlinevirtual

Set the list of points that connect the element to the bus.

Parameters

pointList List of points.

Reimplemented in Line.

Definition at line 177 of file Element.h.

◆ SetPosition()

void Element::SetPosition ( const wxPoint2DDouble position )

Set the element position and update the rectangle.

Parameters

position Position value.

Definition at line 25 of file Element.cpp.

◆ SetSelected()

void Element::SetSelected ( bool selected = true )

inline

Set element selection.

Parameters

selected True if selected, false otherwise.

Definition at line 146 of file Element.h.

◆ SetWidth()

void Element::SetWidth ( double width )

inline

Set element width.

Parameters

width Width value.

Definition at line 151 of file Element.h.

◆ ShowForm()

virtual bool Element::ShowForm	(	wxWindow *	parent,
		Element *	element
	)

inlinevirtual

Show element data form.

Parameters

parent	Form parent
element	Element that will be edited.

Returns: True if the form is shown, false otherwise.

Reimplemented in SyncGenerator, SyncMotor, Transformer, Bus, Load, Line, IOControl, Capacitor, Inductor, IndMotor, TransferFunction, Constant, Gain, Sum, MathOperation, Exponential, Limiter, and RateLimiter.

Definition at line 534 of file Element.h.

◆ ShowPickbox()

void Element::ShowPickbox ( bool showPickbox = true )

inline

Set if the pickbox is shown.

Parameters

showPickbox True if show, false otherwise.

Definition at line 161 of file Element.h.

◆ StartMove()

void Element::StartMove ( wxPoint2DDouble position )

virtual

Update the element attributes related to the movement.

Parameters

position Start move position.

Reimplemented in Transformer, ControlElement, Line, Machines, ConnectionLine, Shunt, and Branch.

Definition at line 117 of file Element.cpp.

◆ StringFromDouble()

wxString Element::StringFromDouble	(	double	value,
		int	minDecimal = `1`
	)

static

Convert a double value to string.

Parameters

value	Value to be converted.
minDecimal	Minimum number of decimal places.

Definition at line 320 of file Element.cpp.

◆ WorldToScreen() [1/2]

wxPoint2DDouble Element::WorldToScreen	(	wxPoint2DDouble	translation,
		double	scale,
		double	offsetX = `0.0`,
		double	offsetY = `0.0`
	)		const

virtual

Convert the element position to screen position.

Parameters

translation	System translation.
scale	System scale
offsetX	Offset in X axis.
offsetY	Offset if Y axis.

Definition at line 124 of file Element.cpp.

◆ WorldToScreen() [2/2]

wxPoint2DDouble Element::WorldToScreen	(	wxPoint2DDouble	position,
		wxPoint2DDouble	translation,
		double	scale,
		double	offsetX = `0.0`,
		double	offsetY = `0.0`
	)		const

virtual

Convert a generic position to screen position.

Parameters

position	Position to be converted.
translation	System translation.
scale	System scale.
offsetX	Offset in X axis.
offsetY	Offset in Y axis.

Definition at line 130 of file Element.cpp.

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

Project/Element.h
Project/Element.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ AddChild()

◆ AddParent() [1/2]

◆ AddParent() [2/2]

◆ AddPoint()

◆ CalculateBoundaries()

◆ Contains()

◆ DoubleFromString()

◆ Draw()

◆ DrawCircle()

◆ DrawLine()

◆ DrawPickbox()

◆ DrawPoint()

◆ DrawRectangle() [1/2]

◆ DrawRectangle() [2/2]

◆ DrawTriangle()

◆ GeneralMenuItens()

◆ GetAngle()

◆ GetBestPickboxCursor()

◆ GetChildList()

◆ GetContextMenu()

◆ GetCopy()

◆ GetHeight()

◆ GetID()

◆ GetParentList()

◆ GetPointList()

◆ GetPosition()

◆ GetRect()

◆ GetRotationAngle()

◆ GetTipText()

◆ GetWidth()

◆ Intersects()

◆ IntFromString()

◆ IsDragging()

◆ IsOnline()

◆ IsPickboxShown()

◆ IsSelected()

◆ Move()

◆ MoveNode()

◆ MovePickbox()

◆ NodeContains()

◆ PickboxContains()

◆ PointToLineDistance()

◆ RemoveChild()

◆ RemoveParent()

◆ ReplaceChild()

◆ ReplaceParent()

◆ Rotate()

◆ RotateAtPosition()

◆ RotatedRectanglesIntersects()

◆ RotateNode()

◆ SetAngle()

◆ SetBorderSize()

◆ SetDragging()

◆ SetHeight()

◆ SetID()

◆ SetNodeParent()

◆ SetOnline()

◆ SetPointList()

◆ SetPosition()

◆ SetSelected()

◆ SetWidth()

◆ ShowForm()

◆ ShowPickbox()

◆ StartMove()

◆ StringFromDouble()

◆ WorldToScreen() [1/2]

◆ WorldToScreen() [2/2]