wxShapeFramework  1.13.0 beta
wxSFOrthoLineShape Class Reference

Orthogonal line shape. The class extends wxSFLineShape class and allows user to create connection line orthgonal to base axis. More...

#include <OrthoShape.h>

Inheritance diagram for wxSFOrthoLineShape:
Collaboration diagram for wxSFOrthoLineShape:

List of all members.

Public Member Functions

 XS_DECLARE_CLONABLE_CLASS (wxSFOrthoLineShape)
 wxSFOrthoLineShape ()
 Default constructor.
 wxSFOrthoLineShape (long src, long trg, const wxXS::RealPointList &path, wxSFDiagramManager *manager)
 User constructor.
 wxSFOrthoLineShape (const wxSFOrthoLineShape &obj)
 Copy constructor.
virtual ~wxSFOrthoLineShape ()
 Destructor.

Protected Member Functions

virtual void DrawCompleteLine (wxDC &dc)
 Internal function used for drawing of completed line shape.
virtual int GetHitLinesegment (const wxPoint &pos)
 Get index of the line segment intersecting the given point.
virtual void DrawLineSegment (wxDC &dc, const wxRealPoint &src, const wxRealPoint &trg)
 Draw one orthogonal line segment.
void GetFirstSubsegment (const wxRealPoint &src, const wxRealPoint &trg, wxRealPoint &subsrc, wxRealPoint &subtrg)
 Get first part of orthogonal line segment.
void GetMiddleSubsegment (const wxRealPoint &src, const wxRealPoint &trg, wxRealPoint &subsrc, wxRealPoint &subtrg)
 Get middle part of orthogonal line segment.
void GetLastSubsegment (const wxRealPoint &src, const wxRealPoint &trg, wxRealPoint &subsrc, wxRealPoint &subtrg)
 Get last part of orthogonal line segment.

Detailed Description

Orthogonal line shape. The class extends wxSFLineShape class and allows user to create connection line orthgonal to base axis.


Constructor & Destructor Documentation

Default constructor.

wxSFOrthoLineShape::wxSFOrthoLineShape ( long  src,
long  trg,
const wxXS::RealPointList &  path,
wxSFDiagramManager manager 
)

User constructor.

Parameters:
srcID of the source shape
trgID of the target shape
pathArray of line's control points
managerParent parent diagram manager

Copy constructor.

Parameters:
objReference to the source object

Destructor.


Member Function Documentation

virtual void wxSFOrthoLineShape::DrawCompleteLine ( wxDC &  dc) [protected, virtual]

Internal function used for drawing of completed line shape.

Parameters:
dcRefernce of the device context where the shape will be darwn to

Reimplemented from wxSFLineShape.

virtual void wxSFOrthoLineShape::DrawLineSegment ( wxDC &  dc,
const wxRealPoint &  src,
const wxRealPoint &  trg 
) [protected, virtual]

Draw one orthogonal line segment.

Parameters:
dcDevice context
srcStarting point of the ortho line segment.
trgEnding point of the ortho line segment.

Reimplemented in wxSFRoundOrthoLineShape.

void wxSFOrthoLineShape::GetFirstSubsegment ( const wxRealPoint &  src,
const wxRealPoint &  trg,
wxRealPoint &  subsrc,
wxRealPoint &  subtrg 
) [protected]

Get first part of orthogonal line segment.

Parameters:
srcStaring point of the ortho line segment
trgEnding point of the ortho line segment
subsrcStarting point of the first part of ortho line segment
subtrgEnding point of the first part of ortho line segment
virtual int wxSFOrthoLineShape::GetHitLinesegment ( const wxPoint &  pos) [protected, virtual]

Get index of the line segment intersecting the given point.

Parameters:
posExamined point
Returns:
Zero-based index of line segment located under the given point

Reimplemented from wxSFLineShape.

void wxSFOrthoLineShape::GetLastSubsegment ( const wxRealPoint &  src,
const wxRealPoint &  trg,
wxRealPoint &  subsrc,
wxRealPoint &  subtrg 
) [protected]

Get last part of orthogonal line segment.

Parameters:
srcStaring point of the ortho line segment
trgEnding point of the ortho line segment
subsrcStarting point of the third part of ortho line segment
subtrgEnding point of the third part of ortho line segment
void wxSFOrthoLineShape::GetMiddleSubsegment ( const wxRealPoint &  src,
const wxRealPoint &  trg,
wxRealPoint &  subsrc,
wxRealPoint &  subtrg 
) [protected]

Get middle part of orthogonal line segment.

Parameters:
srcStaring point of the ortho line segment
trgEnding point of the ortho line segment
subsrcStarting point of the second part of ortho line segment
subtrgEnding point of the second part of ortho line segment

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