wxShapeFramework  1.13.0 beta
wxSFLayoutVerticalTree Class Reference

Class encapsulating algorithm which layouts all top-most shapes into vertical tree registered under "Vertical Tree" name. More...

#include <AutoLayout.h>

Inheritance diagram for wxSFLayoutVerticalTree:
Collaboration diagram for wxSFLayoutVerticalTree:

Public Member Functions

 wxSFLayoutVerticalTree ()
 Constructor. More...
 
virtual ~wxSFLayoutVerticalTree ()
 Destructor. More...
 
virtual void DoLayout (ShapeList &shapes)
 Function performing the layout change. More...
 
void SetHSpace (double HSpace)
 Set horizontal space between shapes. More...
 
void SetVSpace (double VSpace)
 Set vertical space between shapes. More...
 
double GetHSpace () const
 Get horizontal space. More...
 
double GetVSpace () const
 Get vertical space. More...
 
- Public Member Functions inherited from wxSFLayoutAlgorithm
virtual ~wxSFLayoutAlgorithm ()
 Destructor. More...
 

Protected Member Functions

void ProcessNode (wxSFShapeBase *node, double y)
 Process single shape. More...
 
- 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...
 

Protected Attributes

double m_nMinX
 
int m_nCurrMaxWidth
 
double m_HSpace
 
double m_VSpace
 

Detailed Description

Class encapsulating algorithm which layouts all top-most shapes into vertical tree registered under "Vertical Tree" name.

Constructor & Destructor Documentation

◆ wxSFLayoutVerticalTree()

wxSFLayoutVerticalTree::wxSFLayoutVerticalTree ( )
inline

Constructor.

◆ ~wxSFLayoutVerticalTree()

virtual wxSFLayoutVerticalTree::~wxSFLayoutVerticalTree ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ DoLayout()

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

Function performing the layout change.

Parameters
shapesList of shapes which should be layouted

Implements wxSFLayoutAlgorithm.

◆ GetHSpace()

double wxSFLayoutVerticalTree::GetHSpace ( ) const
inline

Get horizontal space.

Returns
Horizontal space in pixels.

◆ GetVSpace()

double wxSFLayoutVerticalTree::GetVSpace ( ) const
inline

Get vertical space.

Returns
Vertical space in pixels.

◆ ProcessNode()

void wxSFLayoutVerticalTree::ProcessNode ( wxSFShapeBase node,
double  y 
)
protected

Process single shape.

Parameters
nodePointer to processed shape.
yVertical position of the shape.

◆ SetHSpace()

void wxSFLayoutVerticalTree::SetHSpace ( double  HSpace)
inline

Set horizontal space between shapes.

Parameters
HSpaceHorizontal space in pixels.

◆ SetVSpace()

void wxSFLayoutVerticalTree::SetVSpace ( double  VSpace)
inline

Set vertical space between shapes.

Parameters
VSpaceVertical space in pixels.

Member Data Documentation

◆ m_HSpace

double wxSFLayoutVerticalTree::m_HSpace
protected

◆ m_nCurrMaxWidth

int wxSFLayoutVerticalTree::m_nCurrMaxWidth
protected

◆ m_nMinX

double wxSFLayoutVerticalTree::m_nMinX
protected

◆ m_VSpace

double wxSFLayoutVerticalTree::m_VSpace
protected

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