wxShapeFramework  1.13.0 beta
wxSFEllipseShape Class Reference

Class encapsulating the ellipse shape. It extends the basic rectangular shape. More...

#include <EllipseShape.h>

Inheritance diagram for wxSFEllipseShape:
Collaboration diagram for wxSFEllipseShape:

List of all members.

Public Member Functions

 XS_DECLARE_CLONABLE_CLASS (wxSFEllipseShape)
 wxSFEllipseShape (void)
 Default constructor.
 wxSFEllipseShape (const wxRealPoint &pos, const wxRealPoint &size, wxSFDiagramManager *manager)
 User constructor.
 wxSFEllipseShape (const wxSFEllipseShape &obj)
 Copy constructor.
virtual ~wxSFEllipseShape ()
 Destructor.
virtual bool Contains (const wxPoint &pos)
 Test whether the given point is inside the shape. The function can be overrided if neccessary.
virtual wxRealPoint GetBorderPoint (const wxRealPoint &start, const wxRealPoint &end)
 Get intersection point of the shape border and a line leading from 'start' point to 'end' point. The function can be overrided if neccessary.

Protected Member Functions

virtual void DrawNormal (wxDC &dc)
 Draw the shape in the normal way. The function can be overrided if neccessary.
virtual void DrawHover (wxDC &dc)
 Draw the shape in the hower mode (the mouse cursor is above the shape). The function can be overrided if neccessary.
virtual void DrawHighlighted (wxDC &dc)
 Draw the shape in the highlighted mode (another shape is dragged over this shape and this shape will accept the dragged one if it will be dropped on it). The function can be overrided if neccessary.
virtual void DrawShadow (wxDC &dc)
 Draw shadow under the shape. The function can be overrided if neccessary.

Detailed Description

Class encapsulating the ellipse shape. It extends the basic rectangular shape.

See also:
wxSFRectShape

Constructor & Destructor Documentation

Default constructor.

wxSFEllipseShape::wxSFEllipseShape ( const wxRealPoint &  pos,
const wxRealPoint &  size,
wxSFDiagramManager manager 
)

User constructor.

Parameters:
posInitial position
sizeInitial size
managerPointer to parent diagram manager

Copy constructor.

Parameters:
objReference to the source shape
virtual wxSFEllipseShape::~wxSFEllipseShape ( ) [virtual]

Destructor.


Member Function Documentation

virtual bool wxSFEllipseShape::Contains ( const wxPoint &  pos) [virtual]

Test whether the given point is inside the shape. The function can be overrided if neccessary.

Parameters:
posExamined point
Returns:
TRUE if the point is inside the shape area, otherwise FALSE

Reimplemented from wxSFShapeBase.

virtual void wxSFEllipseShape::DrawHighlighted ( wxDC &  dc) [protected, virtual]

Draw the shape in the highlighted mode (another shape is dragged over this shape and this shape will accept the dragged one if it will be dropped on it). The function can be overrided if neccessary.

Parameters:
dcReference to device context where the shape will be drawn to

Reimplemented from wxSFRectShape.

virtual void wxSFEllipseShape::DrawHover ( wxDC &  dc) [protected, virtual]

Draw the shape in the hower mode (the mouse cursor is above the shape). The function can be overrided if neccessary.

Parameters:
dcReference to device context where the shape will be drawn to

Reimplemented from wxSFRectShape.

virtual void wxSFEllipseShape::DrawNormal ( wxDC &  dc) [protected, virtual]

Draw the shape in the normal way. The function can be overrided if neccessary.

Parameters:
dcReference to device context where the shape will be drawn to

Reimplemented from wxSFRectShape.

virtual void wxSFEllipseShape::DrawShadow ( wxDC &  dc) [protected, virtual]

Draw shadow under the shape. The function can be overrided if neccessary.

Parameters:
dcReference to device context where the shadow will be drawn to

Reimplemented from wxSFRectShape.

virtual wxRealPoint wxSFEllipseShape::GetBorderPoint ( const wxRealPoint &  start,
const wxRealPoint &  end 
) [virtual]

Get intersection point of the shape border and a line leading from 'start' point to 'end' point. The function can be overrided if neccessary.

Parameters:
startStarting point of the virtual intersection line
endEnding point of the virtual intersection line
Returns:
Intersection point

Reimplemented from wxSFRectShape.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines