wxSFLayoutAlgorithm Class Reference

Base class for all layouting algorithms. The class containts one abstract function modifying shapes' layout and several helper functions. More...

#include <AutoLayout.h>

Inheritance diagram for wxSFLayoutAlgorithm:

Collaboration diagram for wxSFLayoutAlgorithm:

Public Member Functions
virtual	~wxSFLayoutAlgorithm ()
	Destructor. More...
virtual void	DoLayout (ShapeList &shapes)=0
	Function performing the layout change. All derived classes must implement it. More...

Protected Member Functions
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

Base class for all layouting algorithms. The class containts one abstract function modifying shapes' layout and several helper functions.

Constructor & Destructor Documentation

~wxSFLayoutAlgorithm()

virtual wxSFLayoutAlgorithm::~wxSFLayoutAlgorithm ( )

inlinevirtual

Destructor.

Member Function Documentation

DoLayout()

virtual void wxSFLayoutAlgorithm::DoLayout ( ShapeList &  shapes )

pure virtual

Function performing the layout change. All derived classes must implement it.

Parameters

shapes

List of shapes which should be layouted

Implemented in wxSFLayoutMesh, wxSFLayoutHorizontalTree, wxSFLayoutVerticalTree, and wxSFLayoutCircle.

GetBoundingBox()

wxRect wxSFLayoutAlgorithm::GetBoundingBox ( const ShapeList &  shapes )

protected

Calculate bounding box surroundig given shapes.

Parameters

shapes

List of shapes

Returns

Bounding box

GetShapesCenter()

wxRealPoint wxSFLayoutAlgorithm::GetShapesCenter ( const ShapeList &  shapes )

protected

Get center point of given shapes.

Parameters

shapes

List of shapes

Returns

Center point

GetShapesExtent()

wxSize wxSFLayoutAlgorithm::GetShapesExtent ( const ShapeList &  shapes )

protected

Get overall extent of all given shapes calculated as a sum of their width and height.

Parameters

shapes

List of shapes

Returns

Overall shapes extent

GetTopLeft()

wxRealPoint wxSFLayoutAlgorithm::GetTopLeft ( const ShapeList &  shapes )

protected

Get top-left point of bounding box surrounding given shapes.

Parameters

shapes

List of shapes

Returns

Top-left point of bounding box surrounding given shapes

---

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

• AutoLayout.h