wxShapeFramework  1.13.0 beta
wxSFCircleShape Class Reference

Class encapsulating the circle shape. More...

#include <CircleShape.h>

Inheritance diagram for wxSFCircleShape:
Collaboration diagram for wxSFCircleShape:

List of all members.

Public Member Functions

 XS_DECLARE_CLONABLE_CLASS (wxSFCircleShape)
 wxSFCircleShape (void)
 Default constructor.
 wxSFCircleShape (const wxRealPoint &pos, double radius, wxSFDiagramManager *manager)
 User constructor.
 wxSFCircleShape (const wxSFCircleShape &obj)
 Copy constructor.
virtual ~wxSFCircleShape ()
 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 circle shape.


Constructor & Destructor Documentation

Default constructor.

wxSFCircleShape::wxSFCircleShape ( const wxRealPoint &  pos,
double  radius,
wxSFDiagramManager manager 
)

User constructor.

Parameters:
posInitial shape position
radiusCircle radius
managerPointer to parent manager

Copy constructor.

Parameters:
objReference to the source object
virtual wxSFCircleShape::~wxSFCircleShape ( ) [virtual]

Destructor.


Member Function Documentation

virtual bool wxSFCircleShape::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 wxSFCircleShape::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 wxSFCircleShape::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 wxSFCircleShape::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 wxSFCircleShape::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 wxSFCircleShape::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