PolylineAppendNode Class Reference

Append node to existing polyline. More...

Inheritance diagram for PolylineAppendNode:

List of all members.

Public Member Functions
void	beginEvent ()
	Called when the user starts this action by clicking a button, choosing a menu, entering a command, etc.
void	escapeEvent ()
	Called when the user presses Escape or clicks the right mouse button.
void	getHighlightedEntities ()
	Called by updatePreview.
void	getOperation (void preview)
	Called by updatePreview.
void	initState ()
	Called to initialize a new state of this action.
void	pickEntity (void event, void preview)
	High level event triggered when an entity was picked by the user or to preview picking an entity.
void	PolylineAppendNode (void guiAction)
Public Member Functions inherited from DrawPolyline
void	checkButtonStates ()
	Updates the state (enabled / disabled) of the undo and the close buttons depending on the current progress.
void	DrawPolyline (void guiAction)
void	getAuxPreview ()
	Called by updatePreview.
void	pickCoordinate (void event, void preview)
	High level event triggered when a coordinate was specified by the user of a coordinate specification should be previewed.
void	showUiOptions (void resume)
void	slotArcSegmentChanged (void value)
	Called when user toggles 'Arc segment' check box to indicate if the next segment is a line or an arc segment.
void	slotClose ()
	Called when user clicks the 'Close' button to close the polyline.
void	slotRadiusChanged (void value)
	Called when user enters a radius for the next arc segment.
void	slotUndo ()
	Called when user clicks the 'Undo' button to remove the last added vertex.
void	uncheckArcSegment ()
	Called internally to automatically uncheck the 'Arc segment' check box.
Public Member Functions inherited from Polyline
void	getClosestSegment (void pos)
void	getTitle ()
void	Polyline (void guiAction)
Public Member Functions inherited from Draw
void	Draw (void guiAction)
Public Member Functions inherited from EAction
void	applyCommand (void event, void preview)
	High level event triggered when a command line command should be applied or previewed.
void	applyOperation ()
	Applies the operation returned by this.getOperation().
void	commandEvent (void event)
	Default implementation.
void	commandEventPreview (void event)
	Default implementation.
void	coordinateEvent (void event)
	Default implementation.
void	coordinateEventPreview (void event)
	Default implementation.
void	createDialog (void uiFile, void parent)
	Creates a new dialog based on the given UI file with the given parent.
void	createWidget (void uiFile, void parent)
	Creates a new widget based on the given UI file with the given parent.
void	EAction (void guiAction)
void	entityPickEvent (void event)
	Default implementation.
void	entityPickEventPreview (void event)
	Default implementation.
void	finishEvent ()
	Called when this action is terminated.
void	getDocumentInterface ()
void	getScales ()
void	hideUiOptions (void saveToSettings)
	Hides the UI options of this action.
void	initUiOptions (void resume)
	Overwrite to initialize combo boxes and other UI elements of the options tool bar.
void	keyPressEvent (void event)
	Called when the user presses a key.
void	keyReleaseEvent (void event)
	Called when the user releases a key.
void	mousePressEvent (void event)
	Does nothing.
void	mouseReleaseEvent (void event)
void	propertyChangeEvent (void event)
	Allows all actions to handle property change events.
void	resumeEvent ()
	Called whenver the action resumes its operation, for example after it was temporary suspended for another action.
void	setArrowCursor ()
	Sets the current cursor of the current document interface (all views attached to it) to the normal arrow cursor.
void	setCommandPrompt (void prompt)
void	setCrosshairCursor ()
	Sets the current cursor of the current document interface (all views attached to it) to crosshair cursor.
void	setLeftMouseTip (void tip)
void	setRightMouseTip (void tip)
void	setState (void state)
	Set the state of this action.
void	setUiOptions (void uiFile, void split)
	Sets the UI options toolbar content for this tool.
void	showUiOptions (void resume, void restoreFromSettings)
	Shows the UI options of this action if this.uiFile is set.
void	simulateMouseMoveEvent ()
void	slotReset ()
	Called if the user clicks the reset button of an action.
void	suspendEvent ()
	Called whenver the action is suspended, for example if another action is started while this action is active.
void	updatePreview (void clear)
	Updates the preview based on the operation returned by getOperation and the auxiliary construction returned be getAuxPreview.
Public Member Functions inherited from RActionAdapter
virtual void	commandEvent (RCommandEvent &)
	Called when a command is entered in the command line.
virtual void	commandEventPreview (RCommandEvent &)
	Called when a command is being edited in the command line.
virtual void	coordinateEvent (RCoordinateEvent &)
	Called for every coordinate event.
virtual void	coordinateEventPreview (RCoordinateEvent &)
	Called if the action is in PickCoordinate mode and the mouse is moved around.
virtual void	entityPickEvent (REntityPickEvent &)
virtual void	entityPickEventPreview (REntityPickEvent &)
virtual void	keyPressEvent (QKeyEvent &)
virtual void	keyReleaseEvent (QKeyEvent &)
virtual void	mouseDoubleClickEvent (RMouseEvent &)
	Called on mouse double click events.
virtual void	mouseMoveEvent (RMouseEvent &)
	Called on mouse move events.
virtual void	mousePressEvent (RMouseEvent &)
	Called on mouse press events.
virtual void	mouseReleaseEvent (RMouseEvent &)
	Called on mouse release events.
virtual void	panGestureEvent (QPanGesture &)
	Called on pan gesture events.
virtual void	pinchGestureEvent (QPinchGesture &)
	Called on pinch gesture events.
virtual void	propertyChangeEvent (RPropertyEvent &)
	Called when the value of a property is modified while this action is active.
	RActionAdapter (RGuiAction *guiAction=NULL)
virtual void	setGraphicsView (RGraphicsView *)
	Called if this action is set as a navigation action of a graphics view.
virtual void	swipeGestureEvent (QSwipeGesture &)
	Called on swipe gesture events.
virtual void	tabletEvent (RTabletEvent &)
	Called on tablet events.
virtual void	wheelEvent (RWheelEvent &)
	Called on mouse wheel events.
Public Member Functions inherited from RAction
RAction::ClickMode	getClickMode ()
RDocument *	getDocument ()
QList< RGraphicsScene * >	getGraphicsScenes ()
virtual RGuiAction *	getGuiAction ()
RAction *	getOverrideBase ()
RStorage *	getStorage ()
QString	getUniqueGroup ()
bool	hasNoState ()
bool	isOverride ()
bool	isTerminated ()
	RAction (RGuiAction *guiAction=NULL)
void	setClickMode (RAction::ClickMode m)
	Sets the current click mode.
void	setDocumentInterface (RDocumentInterface *di)
void	setGuiAction (RGuiAction *guiAction)
void	setNoState ()
void	setOverride ()
void	setOverrideBase (RAction *base)
void	setUniqueGroup (const QString &ug)
RVector	snap (RMouseEvent &event)
	Uses the currently active snap function to snap to the closest object or grid point.
void	terminate ()
	Terminates the action.
virtual	~RAction ()

Additional Inherited Members
Public Attributes inherited from DrawPolyline
int	arcSegment
int	polylineEntity
int	prepend
int	radius
int	segment

---

Detailed Description

Append node to existing polyline.

1. User chooses start or end segment of an existing polyline.
2. User clicks position of new node, like drawing polyline.

---

Constructor & Destructor Documentation

void PolylineAppendNode::PolylineAppendNode ( void  guiAction )

inline

---

Member Function Documentation

void PolylineAppendNode::beginEvent ( void  )

inlinevirtual

Called when the user starts this action by clicking a button, choosing a menu, entering a command, etc.

Shows the GUI elements that refer to this action as checked. Displays GUI options if this.uiFile is set to a valid UI file. Displays tool help in Help Viewer if available.

Reimplemented from DrawPolyline.

void PolylineAppendNode::escapeEvent ( void  )

inlinevirtual

Called when the user presses Escape or clicks the right mouse button.

Reimplemented from DrawPolyline.

void PolylineAppendNode::getHighlightedEntities ( )

inline

Called by updatePreview.

Implementations must return an array of enitity IDs which should be highlighted.

Reimplemented from EAction.

void PolylineAppendNode::getOperation ( void  preview )

inline

Called by updatePreview.

Implementations must return an ROperation subclass object for the operation that should be previewed.

Reimplemented from DrawPolyline.

void PolylineAppendNode::initState ( void  )

inline

Called to initialize a new state of this action.

Overwrite to set mouse tips, show desired toolbars, etc.

Reimplemented from DrawPolyline.

void PolylineAppendNode::pickEntity ( void  event, void  preview  )

inline

High level event triggered when an entity was picked by the user or to preview picking an entity.

Reimplemented from EAction.

---

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

• scripts/Draw/Polyline/PolylineAppendNode/PolylineAppendNode.js