CamExporter Class Reference

Implementation of a simple CAM exporter that implements the RFileExporter interface. More...

Inheritance diagram for CamExporter:

List of all members.

Public Member Functions
void	appendToContour (void contour, void prepend)
	Appends / prepends entities to the given contour until no more connected entities can be found.
void	CamExporter (void document, void newDocument)
void	convert (void v)
	Converts the given value v from the document unit into the SVG output unit.
void	endExport ()
	Called at the end of a completed export.
void	exportArcSegment (void arc)
void	exportContourEntity (void entity)
	Exports the given entity.
void	exportEntities (void allBlocks, void undone)
void	exportFile (void fileName)
void	exportLineSegment (void line)
void	exportPoint (void point)
void	fuzzyCompare (void v1, void v2)
void	getContour (void entityId)
	Creates a new contour (Contour object) with the given entity and all connected entities.
void	getDocument ()
void	getOperation ()
void	getStartPosition ()
void	prependToContour (void contour)
void	startExport ()
	Called to start a new, complete export.
void	writeFooter ()
void	writeHeader ()
void	writeLine (void line)
void	writeToolUp ()
Public Member Functions inherited from RFileExporterAdapter
virtual void	exportArcSegment (const RArc &)
virtual bool	exportFile (const QString &fileName, const QString &nameFilter, bool setFileName=true)
	Must be implemented by file exporters to export the document into the given file.
virtual void	exportLineSegment (const RLine &)
	Exports a line segment (a line without pattern).
virtual void	exportPoint (const RPoint &)
	Exports a point with the current attributes.
virtual void	exportTriangle (const RTriangle &)
	Exports a triangle with the current attributes.
virtual double	getPatternFactor ()
	RFileExporterAdapter ()
	RFileExporterAdapter (RDocument &document)
virtual	~RFileExporterAdapter ()
Public Member Functions inherited from RFileExporter
virtual QString	getCorrectedFileName (const QString &fileName, const QString &nameFilter)=0
	Must be implemented by file exporters to correct the given file name if necesary (add extension based on chosen name filter).
	RFileExporter ()
	RFileExporter (RDocument &document)
virtual	~RFileExporter ()
Public Member Functions inherited from RExporter
virtual void	endEntity ()
virtual void	exportArc (const RArc &arc, double offset=RNANDOUBLE)
virtual void	exportBlock (RBlock &)
virtual void	exportBlock (RBlock::Id blockId)
virtual void	exportBlocks ()
virtual void	exportBoundingBoxPaths (const QList< RPainterPath > &paths)
virtual void	exportBox (const RBox &box)
	Exports the surfaces of the given box.
virtual void	exportCircle (const RCircle &circle)
	Exports a circle with the current attributes.
virtual void	exportCurrentEntity (bool preview=false)
	The default implementation calls the REntity::exportEntity() function of the entity.
virtual bool	exportDocument ()
	Exports the visual representation of all objects (including entities) of the document->
virtual void	exportDocumentSetting (const QString &, const QVariant &)
virtual bool	exportDocumentSettings ()
virtual void	exportEllipse (const REllipse &ellipse, double offset=RNANDOUBLE)
	Exports an ellipse with the current attributes.
virtual void	exportEntities (bool allBlocks=true, bool undone=false)
virtual void	exportEntities (const RBox &box)
	Exports the visual representation of all entities that are completely or partly inside the given area.
virtual void	exportEntities (QSet< REntity::Id > &entityIds, bool allBlocks=true)
	Calls exportEntity() for all given entities.
virtual void	exportEntity (REntity &e, bool preview=false, bool allBlocks=true)
	Sets the current entity to the given entity and calls exportEntity().
virtual void	exportEntity (REntity::Id entityId, bool allBlocks=true)
	Calls exportEntity(REntity*) for the entity with the given ID.
virtual void	exportExplodable (const RExplodable &explodable, double offset=RNANDOUBLE)
virtual void	exportImage (const RImageData &image)
virtual void	exportLayer (RLayer &)
virtual void	exportLayer (RLayer::Id layerId)
virtual void	exportLayers ()
virtual void	exportLine (const RLine &line, double offset=RNANDOUBLE)
	Exports a line with the current attributes.
virtual void	exportLinetype (RLinetype &)
virtual void	exportLinetypes ()
virtual void	exportPainterPaths (const QList< RPainterPath > &paths)
virtual void	exportPainterPathSource (const RPainterPathSource &pathSource)
virtual void	exportPolyline (const RPolyline &polyline, double offset=RNANDOUBLE)
virtual void	exportQuad (const RVector &p1, const RVector &p2, const RVector &p3, const RVector &p4)
	Exports a quadrilateral with the current attributes.
virtual void	exportRectangle (const RVector &p1, const RVector &p2)
	Exports a rectangle with the current attributes.
virtual void	exportShape (QSharedPointer< RShape > shape)
	Exports the given shapes as part of the geometry of the current entity.
virtual void	exportShapes (const QList< QSharedPointer< RShape > > &shapes)
	Exports the given shapes as part of the geometry of the current entity.
virtual void	exportSpline (const RSpline &spline, double offset=RNANDOUBLE)
virtual void	exportTrialEntities ()
virtual void	exportVerticalQuad (const RVector &p1, const RVector &p2, double height)
	Exports a vertical quadrilateral with the two given base points and the given height.
virtual void	exportView (RView &)
virtual void	exportView (RView::Id viewId)
virtual void	exportViews ()
virtual REntity *	getBlockRefOrEntity ()
virtual QBrush	getBrush (const RPainterPath &path)
virtual QBrush	getBrush ()
RDocument &	getDocument () const
bool	getDraftMode () const
virtual REntity *	getEntity ()
	Sets the current export color for entities.
virtual const REntity *	getEntity () const
QStack< REntity * >	getEntityStack ()
QString	getErrorMessage () const
RLinetypePattern	getLinetypePattern ()
double	getPatternOffset (double length, const RLinetypePattern &pattern)
double	getPatternOffset (double length, const RLinetypePattern &pattern, int index, double *gap=NULL)
virtual QPen	getPen (const RPainterPath &path)
virtual QPen	getPen ()
RS::ProjectionRenderingHint	getProjectionRenderingHint ()
virtual bool	isEntitySelected ()
bool	isVisualExporter () const
	RExporter ()
	RExporter (RDocument &document)
void	setBlockSource (RDocument *bs)
virtual void	setBrush (const QBrush &brush)
virtual void	setBrushStyle (Qt::BrushStyle brushStyle)
virtual void	setColor (float r, float g, float b, float a=1.0f)
	Sets the current export color in RGB and Alpha.
virtual void	setColor (const RColor &color)
virtual void	setDashPattern (const QVector< qreal > &dashes)
void	setDraftMode (bool on)
virtual void	setEntityAttributes ()
void	setLayerSource (RDocument *ls)
virtual void	setLinetypeId (RLinetype::Id ltId)
virtual void	setLinetypePattern (const RLinetypePattern &ltPattern)
virtual void	setLineweight (RLineweight::Lineweight weight)
virtual void	setPen (const QPen &pen)
	Sets the current pen (currentPen).
void	setProjectionRenderingHint (RS::ProjectionRenderingHint p)
	Sets a rendering hint for the current projection used for exports.
virtual void	setStyle (Qt::PenStyle penStyle)
void	setVisualExporter (bool on)
virtual void	startEntity (bool)
virtual void	unexportEntity (REntity::Id entityId)
	This is called for entities for which an export was requested but which cannot be instantiated because they either do not exist (anymore) in the DB or they are currently undone.
virtual	~RExporter ()

Public Attributes
int	document
int	newDocument
int	op
int	scale
int	stream
int	tolerance
int	traversed
int	unit

---

Detailed Description

Implementation of a simple CAM exporter that implements the RFileExporter interface.

This is the base class for all CAM configuration classes in the 'cam' directory of the application installation.

---

Constructor & Destructor Documentation

void CamExporter::CamExporter ( void  document, void  newDocument  )

inline

---

Member Function Documentation

void CamExporter::appendToContour ( void  contour, void  prepend  )

inline

Appends / prepends entities to the given contour until no more connected entities can be found.

Parameters:

contour	Contour object with the IDs of the entities in this contour.
prepend	Boolean true: prepend instead of append, false: append (default).

void CamExporter::convert ( void  v )

inline

Converts the given value v from the document unit into the SVG output unit.

void CamExporter::endExport ( )

inlinevirtual

Called at the end of a completed export.

The default implementation does nothing.

Reimplemented from RExporter.

void CamExporter::exportArcSegment ( void  arc )

inline

void CamExporter::exportContourEntity ( void  entity )

inline

Exports the given entity.

Parameters:

entity

Entity object of entity ID.

void CamExporter::exportEntities ( void  allBlocks, void  undone  )

inline

void CamExporter::exportFile ( void  fileName )

inline

void CamExporter::exportLineSegment ( void  line )

inline

void CamExporter::exportPoint ( void  point )

inline

void CamExporter::fuzzyCompare ( void  v1, void  v2  )

inline

void CamExporter::getContour ( void  entityId )

inline

Creates a new contour (Contour object) with the given entity and all connected entities.

void CamExporter::getDocument ( )

inline

void CamExporter::getOperation ( )

inline

void CamExporter::getStartPosition ( )

inline

void CamExporter::prependToContour ( void  contour )

inline

void CamExporter::startExport ( )

inlinevirtual

Called to start a new, complete export.

Implementors can for example clear any stored exported entities or caches. The default implementation does nothing.

Reimplemented from RExporter.

void CamExporter::writeFooter ( )

inline

Reimplemented in GCode.

void CamExporter::writeHeader ( )

inline

Reimplemented in GCode.

void CamExporter::writeLine ( void  line )

inline

Reimplemented in GCode.

void CamExporter::writeToolUp ( )

inline

Reimplemented in GCode.

---

Member Data Documentation

int CamExporter::document

Reimplemented from RExporter.

int CamExporter::newDocument

int CamExporter::op

int CamExporter::scale

Reimplemented in GCode.

int CamExporter::stream

int CamExporter::tolerance

int CamExporter::traversed

int CamExporter::unit

---

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

• scripts/Cam/CamExport/CamExporter.js