A line that can be put in a drawing. More...

#include <line.h>

Inheritance diagram for lc::entity::Line:

Collaboration diagram for lc::entity::Line:

Public Member Functions
	Line (const geo::Coordinate &start, const geo::Coordinate &end, const Layer_CSPtr layer, const MetaInfo_CSPtr metaInfo=nullptr, const Block_CSPtr block=nullptr)
	Construct a new line. More...

	Line (const geo::Vector &vector, const Layer_CSPtr layer, const MetaInfo_CSPtr metaInfo=nullptr, const Block_CSPtr block=nullptr)
	Construct a new line. More...

	Line (const Line_CSPtr other, bool sameID=false)

virtual std::vector < EntityCoordinate >	snapPoints (const geo::Coordinate &coord, const SimpleSnapConstrain &constrain, double minDistanceToSnap, int maxNumberOfSnapPoints) const override
	Find a number of snap points the line has available This function returns a ordered list, closest to coord and can return multiple snap points. More...

virtual geo::Coordinate	nearestPointOnPath (const geo::Coordinate &coord) const override
	Find the nearest point on the path for this entity for the coordinate coord The path of a entity that it can possibly take. More...

virtual std::map< unsigned int, lc::geo::Coordinate >	dragPoints () const override
	Get all points of the entity that can be dragged. More...

virtual CADEntity_CSPtr	setDragPoints (std::map< unsigned int, lc::geo::Coordinate > dragPoints) const override
	Return modified entity. More...

virtual CADEntity_CSPtr	move (const geo::Coordinate &offset) const override
	move, moves by an offset More...

virtual CADEntity_CSPtr	copy (const geo::Coordinate &offset) const override
	copy, copies line by an offset More...

virtual CADEntity_CSPtr	rotate (const geo::Coordinate &rotation_center, const double rotation_angle) const override
	rotate, rotate operation More...

virtual CADEntity_CSPtr	scale (const geo::Coordinate &scale_center, const geo::Coordinate &scale_factor) const override
	scale, scales the entity More...

virtual CADEntity_CSPtr	mirror (const geo::Coordinate &axis1, const geo::Coordinate &axis2) const override

virtual const geo::Area	boundingBox () const override
	boundingBox of the entity More...

virtual CADEntity_CSPtr	modify (Layer_CSPtr layer, const MetaInfo_CSPtr metaInfo, Block_CSPtr block) const override
	modify Return a new entity with the same ID bit with possible modified metainfo and/pr layer information #return new entity with same ID More...

virtual void	accept (GeoEntityVisitor &v) const override

virtual void	dispatch (EntityDispatch &ed) const override

Public Member Functions inherited from lc::entity::CADEntity
	CADEntity ()

	CADEntity (Layer_CSPtr layer, const MetaInfo_CSPtr metaInfo=nullptr, const Block_CSPtr block=nullptr)
	CADEntity Constructor. More...

	CADEntity (CADEntity_CSPtr cadEntity, bool sameID)

	CADEntity (CADEntity_CSPtr cadEntity)

virtual	~CADEntity ()=default

Layer_CSPtr	layer () const
	layer return the layer this entity is placed on More...

template<typename T >
const std::shared_ptr< const T >	metaInfo (std::string metaName) const

MetaInfo_CSPtr	metaInfo () const

Block_CSPtr	block () const
	Return the current entity block. More...

Public Member Functions inherited from lc::ID
	ID ()
	Default constructor, provides a new unique ID to each entity. More...

	ID (ID_DATATYPE)

virtual	~ID ()=default

ID_DATATYPE	id () const
	returns the ID of the entity More...

bool	operator== (const ID &id) const

void	setID (ID_DATATYPE id)

Public Member Functions inherited from lc::Visitable
virtual	~Visitable ()=default

Public Member Functions inherited from lc::geo::Vector
	Vector (const Coordinate &start, const Coordinate &end)

	Vector (const Vector &v)

const Coordinate	start () const

const Coordinate	end () const

Vector &	operator= (const Vector &v)

const Coordinate	nearestPointOnPath (const Coordinate &coord) const

const Coordinate	nearestPointOnEntity (const Coordinate &coord) const

double	Angle1 () const

double	Angle2 () const

const maths::Equation	equation () const

Public Member Functions inherited from lc::geo::Base
virtual	~Base ()=default

Private Member Functions
	Line (const builder::LineBuilder &builder)

Friends
class	builder::LineBuilder

Additional Inherited Members
Static Public Member Functions inherited from lc::Snapable
static void	remove_ifDistanceGreaterThen (std::vector< EntityCoordinate > &points, const geo::Coordinate &reference, const double distance)

static void	snapPointsCleanup (std::vector< EntityCoordinate > &points, const geo::Coordinate &reference, const unsigned int maxNumberOfSnapPoints, const double minDistanceToSnap)

Static Public Attributes inherited from lc::ID
static std::atomic< ID_DATATYPE >	__idCounter

Protected Member Functions inherited from lc::entity::CADEntity
	CADEntity (const lc::builder::CADEntityBuilder &builder)

Detailed Description

A line that can be put in a drawing.

A line is a graphics line item that can be put on a drawing using a CreateEntity operation.

See also: CreateEntities::append

Author: R. van Twisk

Date: 2012-04-16

Definition at line 28 of file line.h.

Constructor & Destructor Documentation

Line::Line	(	const geo::Coordinate &	start,
		const geo::Coordinate &	end,
		const Layer_CSPtr	layer,
		const MetaInfo_CSPtr	metaInfo = `nullptr`,
		const Block_CSPtr	block = `nullptr`
	)

Construct a new line.

Parameters

start,end	Coordinate the line should start and end from
metaTypes	A list of metatypes associated with this line

See also: Color; LineWidth; MetaType

Definition at line 9 of file line.cpp.

                                     :
         CADEntity(layer, metaInfo, block),
         geo::Vector(start, end) {
 }

Line::Line	(	const geo::Vector &	vector,
		const Layer_CSPtr	layer,
		const MetaInfo_CSPtr	metaInfo = `nullptr`,
		const Block_CSPtr	block = `nullptr`
	)

Construct a new line.

Parameters

vector	Coordinate the line should start and end from
metaTypes	A list of metatypes associated with this line

See also: Color; LineWidth; MetaType

Definition at line 18 of file line.cpp.

                                     :
         CADEntity(layer, metaInfo, block),
         geo::Vector(vector) {
 }

Line::Line	(	const Line_CSPtr	other,
		bool	sameID = `false`
	)

Definition at line 26 of file line.cpp.

26 : CADEntity(other, sameID), geo::Vector(other->start(), other->end()) {

27 }

lc::geo::Vector

Definition: geovector.h:12

lc::entity::CADEntity::CADEntity

CADEntity()

Definition: cadentity.h:25

Line::Line ( const builder::LineBuilder & builder )

private

Definition at line 29 of file line.cpp.

                                             :
     CADEntity(builder),
     geo::Vector(builder.start(), builder.end()) {
 }

Member Function Documentation

virtual void lc::entity::Line::accept ( GeoEntityVisitor & v ) const

inlineoverridevirtual

Reimplemented from lc::entity::CADEntity.

Definition at line 118 of file line.h.

118 { v.visit(*this); }

const geo::Area Line::boundingBox ( ) const

overridevirtual

boundingBox of the entity

Returns: geo::Area area

Implements lc::entity::CADEntity.

Definition at line 115 of file line.cpp.

                                       {
     return geo::Area(start(), end());
 }

CADEntity_CSPtr Line::copy ( const geo::Coordinate & offset ) const

overridevirtual

copy, copies line by an offset

Parameters

geo::Coordinate offset

Returns: CADEntity_CSPtr copied entity

Implements lc::entity::CADEntity.

Definition at line 75 of file line.cpp.

                                                             {
     auto newLine = std::make_shared<Line>(this->start() + offset,
                                           this->end() + offset,
                                           layer(),
                                           metaInfo(),
                                           block());
     return newLine;
 }

virtual void lc::entity::Line::dispatch ( EntityDispatch & ed ) const

inlineoverridevirtual

Implements lc::entity::CADEntity.

Definition at line 120 of file line.h.

                                                                      {
                 ed.visit(shared_from_this());
             }

std::map< unsigned int, lc::geo::Coordinate > Line::dragPoints ( ) const

overridevirtual

Get all points of the entity that can be dragged.

Returns: Map of points

Implements lc::Draggable.

Definition at line 132 of file line.cpp.

                                                              {
     std::map<unsigned int, lc::geo::Coordinate> points;
 
         points[0] = start();
         points[1] = end();
 
         return points;
 }

CADEntity_CSPtr Line::mirror	(	const geo::Coordinate &	axis1,
		const geo::Coordinate &	axis2
	)		const

overridevirtual

Implements lc::entity::CADEntity.

Definition at line 104 of file line.cpp.

                                                                {
     auto newLine = std::make_shared<Line>(this->start().mirror(axis1, axis2),
                                           this->end().mirror(axis1, axis2),
                                           layer(),
                                           metaInfo(),
                                           block());
     newLine->setID(this->id());
     return newLine;
 }

CADEntity_CSPtr Line::modify	(	Layer_CSPtr	layer,
		const MetaInfo_CSPtr	metaInfo,
		Block_CSPtr	block
	)		const

overridevirtual

modify Return a new entity with the same ID bit with possible modified metainfo and/pr layer information #return new entity with same ID

Implements lc::entity::CADEntity.

Definition at line 119 of file line.cpp.

                                                                                                       {
     auto newEntity = std::make_shared<Line>(
             this->start(),
             this->end(),
             layer,
             metaInfo,
             block
     );
     newEntity->setID(this->id());
 
     return newEntity;
 }

CADEntity_CSPtr Line::move ( const geo::Coordinate & offset ) const

overridevirtual

move, moves by an offset

Parameters

geo::Coordinate offset

Returns: CADEntity_CSPtr moved entity

Implements lc::entity::CADEntity.

Definition at line 64 of file line.cpp.

                                                             {
     auto newLine = std::make_shared<Line>(this->start() + offset,
                                           this->end() + offset,
                                           layer(),
                                           metaInfo(),
                                           block()
     );
     newLine->setID(this->id());
     return newLine;
 }

geo::Coordinate Line::nearestPointOnPath ( const geo::Coordinate & coord ) const

overridevirtual

Find the nearest point on the path for this entity for the coordinate coord The path of a entity that it can possibly take.

For example for any Arc the path is the full circle if the start/stop angle is 0 to 2*pi

Parameters

coord Coordinate to lookup the nearest coordinate from

See also: lc::entity::CADEntity

Implements lc::Snapable.

Definition at line 60 of file line.cpp.

                                                                        {
     return geo::Vector::nearestPointOnPath(coord);
 }

CADEntity_CSPtr Line::rotate	(	const geo::Coordinate &	rotation_center,
		const double	rotation_angle
	)		const

overridevirtual

rotate, rotate operation

Parameters

geo::Coordinate	rotation_center
double	rotation_angle

Returns: CADEntity_CSPtr rotated entity

Implements lc::entity::CADEntity.

Definition at line 84 of file line.cpp.

                                                                                                     {
     auto newLine = std::make_shared<Line>(this->start().rotate(rotation_center, rotation_angle),
                                           this->end().rotate(rotation_center, rotation_angle),
                                           layer(),
                                           metaInfo(),
                                           block());
     newLine->setID(this->id());
     return newLine;
 }

CADEntity_CSPtr Line::scale	(	const geo::Coordinate &	scale_center,
		const geo::Coordinate &	scale_factor
	)		const

overridevirtual

scale, scales the entity

Parameters

geo::Coordinate	scale_center
double	scale_factor

Returns

Implements lc::entity::CADEntity.

Definition at line 94 of file line.cpp.

                                                                                                       {
     auto newLine = std::make_shared<Line>(this->start().scale(scale_center, scale_factor),
                                           this->end().scale(scale_center, scale_factor),
                                           layer(),
                                           metaInfo(),
                                           block());
     newLine->setID(this->id());
     return newLine;
 }

CADEntity_CSPtr Line::setDragPoints ( std::map< unsigned int, lc::geo::Coordinate > dragPoints ) const

overridevirtual

Return modified entity.

Parameters

dragPoints Modified points

Returns: New entity or same entity if an error occurred Return the new entity which corresponds to the given points. Points must be associated to the same number given in dragPoints().

Implements lc::Draggable.

Definition at line 141 of file line.cpp.

                                                                                           {
     try {
             auto newEntity = std::make_shared<Line>(dragPoints.at(0),
                                                 dragPoints.at(1),
                                                 layer(),
                                                 metaInfo(),
                                                 block()
         );
             newEntity->setID(this->id());
             return newEntity;
     }
     catch(const std::out_of_range& e) {
         //A point was not in the map, don't change the entity
         return shared_from_this();
     }
 }

std::vector< EntityCoordinate > Line::snapPoints	(	const geo::Coordinate &	coord,
		const SimpleSnapConstrain &	simpleSnapConstrain,
		double	minDistanceToSnap,
		int	maxNumberOfSnapPoints
	)		const

overridevirtual

Find a number of snap points the line has available This function returns a ordered list, closest to coord and can return multiple snap points.

Parameters

coord	Coordinate to lookup the nearest coordinate from
minDistanceToSnap	Minimum distance to the path to snap into. THis is a hint parameter and we should follow this, but it will be later filtered again
maxNumberOfSnapPoints	Maximum number of snappoints that have to be looked up

See also: lc::EntityCoordinate

Implements lc::Snapable.

Definition at line 34 of file line.cpp.

                                                                                                                                                                          {
     std::vector<EntityCoordinate> points;
 
     if (constrain.constrain() & SimpleSnapConstrain::LOGICAL) {
         points.emplace_back(start(), 0);
         points.emplace_back(end(), 1);
         points.emplace_back(end().mid(start()), 1);
     }
 
 
     const geo::Coordinate npoe = nearestPointOnPath(coord);
     if (constrain.constrain() & SimpleSnapConstrain::ON_ENTITYPATH) {
         points.emplace_back(npoe, 2);
     }
 
     if (constrain.constrain() & SimpleSnapConstrain::ON_ENTITY) {
         if (this->nearestPointOnEntity(coord).distanceTo(coord)<minDistanceToSnap) {
             points.emplace_back(npoe, 3);
         }
     }
 
     // Cleanup array of snappoints
     Snapable::snapPointsCleanup(points, coord, maxNumberOfSnapPoints, minDistanceToSnap);
     return points;
 }

Friends And Related Function Documentation

friend class builder::LineBuilder

friend

Definition at line 29 of file line.h.

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

lckernel/cad/primitive/line.h
lckernel/cad/primitive/line.cpp

Public Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation