Public Member Functions | List of all members
Avoid::ConnEnd Class Reference

The ConnEnd class represents different possible endpoints for connectors. More...

#include <connend.h>

Public Member Functions

 ConnEnd (const Point &point)
 Constructs a ConnEnd from a free-floating point. More...
 
 ConnEnd (ShapeRef *shapeRef, const unsigned int connectionPinClassID)
 Constructs a ConnEnd attached to one of a particular set of connection pins on a shape. More...
 
 ConnEnd (JunctionRef *junctionRef)
 Constructs a ConnEnd attached to one of the connection pins on a junction. More...
 
 ConnEnd (const Point &point, const ConnDirFlags visDirs)
 Constructs a ConnEnd from a free-floating point as well as a set of flags specifying visibility for this point if it is located inside a shape. More...
 
const Point position (void) const
 Returns the position of this connector endpoint. More...
 
ConnDirFlags directions (void) const
 Returns the directions in which this connector endpoint should be given visibility. More...
 

Detailed Description

The ConnEnd class represents different possible endpoints for connectors.

Currently this class just allows free-floating endpoints, but in future will be capable of representing attachment to connection points on shapes.

Constructor & Destructor Documentation

Avoid::ConnEnd::ConnEnd ( const Point point)

Constructs a ConnEnd from a free-floating point.

Parameters
[in]pointThe position of the connector endpoint.
Avoid::ConnEnd::ConnEnd ( ShapeRef shapeRef,
const unsigned int  connectionPinClassID 
)

Constructs a ConnEnd attached to one of a particular set of connection pins on a shape.

This is the ideal method for connecting to shapes that may later be moved or resized and you don't want to track and specify the connections yourself. See the ShapeConnectionPin documentation for more information.

Parameters
[in]shapeRefA pointer to the containing shape's ShapeRef.
[in]connectionPinClassIDAn integer denoting the class ID for the set of pins to connect to.
Avoid::ConnEnd::ConnEnd ( JunctionRef junctionRef)

Constructs a ConnEnd attached to one of the connection pins on a junction.

This is the ideal method for connecting to junctions that may later be moved. See the ShapeConnectionPin documentation for more information.

Parameters
[in]junctionRefA pointer to the containing junction's junctionRef.
Avoid::ConnEnd::ConnEnd ( const Point point,
const ConnDirFlags  visDirs 
)

Constructs a ConnEnd from a free-floating point as well as a set of flags specifying visibility for this point if it is located inside a shape.

Parameters
[in]pointThe position of the connector endpoint.
[in]visDirsOne or more Avoid::ConnDirFlag options specifying the directions that this point should be given visibility if it is inside a shape. Currently has no effect if outside of shapes.

Member Function Documentation

ConnDirFlags Avoid::ConnEnd::directions ( void  ) const

Returns the directions in which this connector endpoint should be given visibility.

Returns
The visibility directions for this connector endpoint.
const Point Avoid::ConnEnd::position ( void  ) const

Returns the position of this connector endpoint.

Returns
The position of this connector endpoint.

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