wxShapeFramework  1.13.0 beta
wxSFLayoutCircle Class Reference

Class encapsulating algorithm which layouts all top-most shapes into circle registered under "Circle" name. The algorithm doesn't optimize connection lines crossing. More...

#include <AutoLayout.h>

Inheritance diagram for wxSFLayoutCircle:
Collaboration diagram for wxSFLayoutCircle:

Public Member Functions

 wxSFLayoutCircle ()
 Constructor. More...
 
virtual ~wxSFLayoutCircle ()
 Destructor. More...
 
virtual void DoLayout (ShapeList &shapes)
 Function performing the layout change. More...
 
void SetDistanceRatio (double DistanceRatio)
 Set ratio in which calculated distance between shapes will be reduced. Values less than 1 means that the distance will be smaller, values bigger than 1 means that the distance will be bigger. More...
 
double GetDistanceRatio () const
 Get distance ratio. More...
 
- Public Member Functions inherited from wxSFLayoutAlgorithm
virtual ~wxSFLayoutAlgorithm ()
 Destructor. More...
 

Protected Attributes

double m_DistanceRatio
 

Additional Inherited Members

- Protected Member Functions inherited from wxSFLayoutAlgorithm
wxRect GetBoundingBox (const ShapeList &shapes)
 Calculate bounding box surroundig given shapes. More...
 
wxSize GetShapesExtent (const ShapeList &shapes)
 Get overall extent of all given shapes calculated as a sum of their width and height. More...
 
wxRealPoint GetShapesCenter (const ShapeList &shapes)
 Get center point of given shapes. More...
 
wxRealPoint GetTopLeft (const ShapeList &shapes)
 Get top-left point of bounding box surrounding given shapes. More...
 

Detailed Description

Class encapsulating algorithm which layouts all top-most shapes into circle registered under "Circle" name. The algorithm doesn't optimize connection lines crossing.

Constructor & Destructor Documentation

◆ wxSFLayoutCircle()

wxSFLayoutCircle::wxSFLayoutCircle ( )
inline

Constructor.

◆ ~wxSFLayoutCircle()

virtual wxSFLayoutCircle::~wxSFLayoutCircle ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ DoLayout()

virtual void wxSFLayoutCircle::DoLayout ( ShapeList &  shapes)
virtual

Function performing the layout change.

Parameters
shapesList of shapes which should be layouted

Implements wxSFLayoutAlgorithm.

◆ GetDistanceRatio()

double wxSFLayoutCircle::GetDistanceRatio ( ) const
inline

Get distance ratio.

Returns
Current distance ratio

◆ SetDistanceRatio()

void wxSFLayoutCircle::SetDistanceRatio ( double  DistanceRatio)
inline

Set ratio in which calculated distance between shapes will be reduced. Values less than 1 means that the distance will be smaller, values bigger than 1 means that the distance will be bigger.

Parameters
DistanceRatioDistance ratio

Member Data Documentation

◆ m_DistanceRatio

double wxSFLayoutCircle::m_DistanceRatio
protected

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