Extension for rendering labels for CSOs. More...

#include <SoCSOLabelRenderer.h>

Inheritance diagram for SoCSOLabelRenderer:

Public Member Functions
	SoCSOLabelRenderer ()
	Standard constructor.

void	setVisibleCSOs (const std::vector< CSODrawCSOInfos > &drawCSOInformation, const CSODrawView2DInfos &view2DInfos, SoView2DCSOExtensibleEditor *editor) override
	Set information about all the CSOs that are to be rendered.

void	draw (const CSODrawCSOInfos &csoInfos, const CSODrawView2DInfos &view2DInfos, const CSODrawSliceInformation &drawSliceInfo, SoView2DCSOExtensibleEditor *editor) override
	Drawing routine.

void	drawSecondPass (const CSODrawCSOInfos &csoInfos, const CSODrawView2DInfos &view2DInfos, const CSODrawSliceInformation &drawSliceInfo, SoView2DCSOExtensibleEditor *editor) override
	Drawing routine that comes between 'main' and 'overlay'.

void	drawOverlay (const CSODrawCSOInfos &csoInfos, const CSODrawView2DInfos &view2DInfos, const CSODrawSliceInformation &drawSliceInfo, SoView2DCSOExtensibleEditor *editor) override
	Routine for drawing after the main routine has drawn.

bool	isModificationEditor () const override
	Returns whether the editor is a modification editor.

void	labelMoveStartPressAt (ml::CSO *cso, const SoPointerPosition &pos)

void	labelMoveDragMoveTo (ml::CSO *cso, const SoPointerPosition &pos)

SoPointingAction *	labelMoveEndPress (ml::CSO *cso, int clickCount)

void	labelResizeStartPressAt (ml::CSO *cso, const SoPointerPosition &pos)

void	labelResizeDragMoveTo (ml::CSO *cso, const SoPointerPosition &pos, int resizeHandlerCode)

SoPointingAction *	labelResizeEndPress (ml::CSO *cso, int clickCount)

void	createStartPressAt (const SoPointerPosition &) override

void	createDragMoveTo (const SoPointerPosition &) override

bool	createEndPress (int) override

void	pointerPositionIfAllowedAt (const SoPointerPosition &) override
	Sets seed points while moving the mouse – but not while dragging.

void	selectAndMoveStartPressAt (const SoPointerPosition &) override

void	selectAndMoveDragMoveTo (const SoPointerPosition &) override

SoPointingAction *	selectAndMoveEndPress (int) override

void	pointerPosition (const SoPointerPosition &pos) override
	Called when the mouse moves over a viewer.

void	pointerLeftWindow () override
	Called when mouse pointer leaves the window.

int	cursorShape () const override
	Returns the cursor shape that indicates the next creation.

void	setLabelUnderMouseForInteraction (ml::CSO *cso)
	Sets the label for the given CSO as being under the mouse for interaction (select, move, resize).

void	setLabelUnderMouseForHighlighting (ml::CSO *cso)
	Sets the label for the given CSO as being under the mouse for highlighting.

bool	shouldRenderGeneral (ml::CSO *) const override
	Returns whether a given CSO should be rendered by this general extension.

void	startDrawing (View2DSliceList *slicelist) override
	Is called before drawing.

ml::CSO *	getLabelCSO (const std::string &currentViewerId, const SoPointerPosition &pos)
	Returns the pointer to a CSO whose label is on the given viewer under the given position.

ml::CSO *	getHitResizeHandler (const std::string &currentViewerId, const SoPointerPosition &pos, int &resizeHandlerCode)
	Returns the pointer to a CSO whose label is on the given viewer under the given position. Fills up the hit resize handler code.

void	setOuterModule (ml::CSOLabelRenderer *labelRendererModule)
	Sets a pointer to the 'outer' module.

void	updateStringsInCache ()
	Updates all label strings in the cache.

void	resetCache () override
	Resets the internal label string cache.

void	computeOutputInformation ()
	Fills output information fields for a CSO on a viewer.

Public Member Functions inherited from SoCSOEditorExtension
void	setExtensibleEditor (SoView2DCSOExtensibleEditor *extensibleEditor)
	Sets the pointer to the calling extensible editor.

virtual void	activate (SoView2DCSOExtensibleEditor *extensibleEditor)
	Is called when an extension is activated by the SoView2DExtensibleEditor.

virtual void	deactivate ()
	Is called when an extension is deactivated by the SoView2DExtensibleEditor.

virtual void	buttonMaskChanged ()
	Is called when the button mask of the SoView2DExtensibleEditor has changed.

virtual void	editingOnChanged ()
	Is called when the editingOn field of the SoView2DExtensibleEditor has changed.

virtual void	drawingDone ()
	Is called when all drawing is done.

virtual void	drawAdditionalGeometry (const CSODrawView2DInfos &view2DInfos, SoView2DCSOExtensibleEditor *editor)
	Routine for drawing additional geometry of the extension.

virtual void	insertSeedPointStartPressAt (const SoPointerPosition &)

virtual void	insertSeedPointDragMoveTo (const SoPointerPosition &)

virtual SoPointingAction *	insertSeedPointEndPress (int)

virtual void	bulgeStartPressAt (const SoPointerPosition &)

virtual void	bulgeDragMoveTo (const SoPointerPosition &)

virtual SoPointingAction *	bulgeEndPress (int)

virtual bool	isCreationAllowed () const
	Returns whether the editor is allowed to create a new CSO.

virtual bool	isCreationAllowedAt (const SoPointerPosition &) const
	Returns whether the editor is allowed to create a new CSO at the given position, by default calls the previous method.

virtual bool	isModificationAllowed () const
	Returns whether the editor is allowed to modify an existing CSO.

virtual bool	shouldRenderCSOs () const
	Returns whether the editor should render.

virtual bool	canCreateCSOs () const
	Returns whether the editor can create a CSO.

virtual ml::CSO *	getActiveCSO () const
	Returns the currently active CSO.

virtual bool	expectsToCreateCSO ()
	Returns whether an editor is awaiting to create a new CSO, depending on the requireMousemovement flag.

SbString	getCreatorExtensionId () const

void	setActiveCSOList (ml::CSOList *hitCSOList)

void	setSelectAndMoveInformation (ml::CSOList hitCSOList, ml::CSO hitCSO, ml::CSOSeedPoint hitSeedPoint, ml::CSOPathPoints hitPathPoints, float hitDistance)

void	setCSOUnderMouse (ml::CSO *cso)

ml::CSO *	getCSOUnderMouse () const

bool	hasSelectedSeedPoint () const

bool	hasSelectedCSO () const

virtual SbString	getSubType () const
	Returns the sub type string of the derived class.

virtual bool	shouldRenderSpecific (ml::CSO *cso) const
	Returns whether a given CSO should be rendered by this specific extension.

virtual bool	isDefaultRenderer () const
	Returns whether the editor is the default editor.

virtual void	cancel ()
	Cancels an action like generating a CSO. Depends on concrete editor.

virtual bool	deleteSeedPoint (ml::CSO cso, ml::CSOSeedPoint )
	Removes the given seed point from the given CSO and returns whether that was successful.

ml::CSOSeedPoint *	getPreviousSeedPoint (ml::CSOSeedPoint *seedPoint) const
	Returns the previous seed point of the given seed point for setting it as the next selected seed point.

virtual void	mouseWheelEventReceived (SoMouseWheelEvent::Orientation, int, View2DEvent *)
	Method is called when the extensible editor received a mouse wheel event.

virtual bool	evaluateHitPoint (const ml::Vector3 &worldPosition, View2DSliceList slicelist, ml::CSOList csoList, const ml::CSOBoundingBox &slabBB, SoView2DCSOExtensibleEditor editor, ml::CSO &localHitCSO, ml::CSOSeedPoint &localHitSeedPoint, ml::CSOPathPoints &localHitPathPoints, float &distance)
	Returns whether the given world position is within the selection distance set in the editor and fills the selection distance.

void	reset ()

ml::CSOVisualizationSettings *	getVisualizationSettings ()
	Returns a pointer to the visual settings that are either the default ones or the ones set to the extensible editor (if present).

bool	shouldShowCSOForCurrentTimePoint (const CSODrawView2DInfos &view2DInfos, ml::CSO *cso)
	Returns whether the given CSO should be rendered for the current time point.

void	sendCSOEventsOnCancel (ml::CSO *cso)
	Sends CSO events for completing a creation or interaction when canceling it.

virtual void	sendCSOEventsOnCancel (ml::CSOList *csoList)

Static Public Member Functions
static void	initClass ()
	init class in inventor runtime

Static Public Member Functions inherited from SoCSOEditorExtension
static void	initClass ()
	init class in inventor runtime

Public Attributes
SoSFMLBase	inLabelPlacement
	Option input of label placement.

SoSFInt32	labelBorderMarginX
	Sets the inner margin of the label border in x-direction.

SoSFInt32	labelBorderMarginY
	Sets the inner margin of the label border in y-direction.

SoSFBool	drawLabelBorderForSelectedCSO
	Shall a border be drawn around the label of a selected CSO?

SoSFBool	shouldRenderLabelName
	Shall the label name be rendered at the CSO when the label has been moved away?

SoSFBool	shouldDrawConnectingLine
	Shall a connecting line between the label and the CSO be drawn?

SoSFBool	shouldHighlightBorderOnMouseOver
	Shall the label's border be highlighted on mouse over?

SoSFFloat	connectingLineAlpha
	Global alpha factor that is multiplied to the local alpha factor of connecting lines.

SoSFBool	allowLabelResize
	Shall the user be allowed to resize a label?

SoSFBool	shouldDrawResizeHandlers
	Shall resize handlers be drawn?

SoSFInt32	minConnectingLineLength
	The minimum length of a connecting line to get drawn (in pixel).

SoSFBool	drawConnectingLineToCenterOfCSO
	Shall the connecting line be drawn to th center of a CSO? Or to the nearest point on the CSO?

SoSFTrigger	repaintTrigger
	Just a dummy field to trigger a repaint.

SoSFInt32	fontSize
	Sets the font size of the text.

SoSFBool	tryToPlaceLabelsWithoutOverlap
	Should the renderer attempt to place a label without overlapping other labels?

SoSFEnum	detachedLabelPlacement
	Positioning strategy for detached (manually moved) labels.

SoSFEnum	viewerBorderHandling
	Handling of labels that move over the viewer's border.

SoSFEnum	movePossibleCursor

SoSFEnum	movePerformCursor

SoSFEnum	scaleNCursor

SoSFEnum	scaleNWCursor

SoSFEnum	scaleWCursor

SoSFEnum	scaleSWCursor

SoSFEnum	scaleSCursor

SoSFEnum	scaleSECursor

SoSFEnum	scaleECursor

SoSFEnum	scaleNECursor


SoSFInt32	inputInfoCSOId
	Trade interface for retrieving the device position (and other information) of a label on a certain viewer.

SoSFString	inputInfoViewerId
	Input of the viewer id string.

SoSFVec2f	outputInfoLabelBoundingBoxStart
	Output of the upper left corner of the label's bounding box.

SoSFVec2f	outputInfoLabelBoundingBoxEnd
	Output of the lower right corner of the label's bounding box.

SoSFString	outputInfoLabelCaption
	Output of the label's caption.

SoSFString	outputInfoLabelString
	Output of the label's string.

SoSFInt32	outputInfoLabelCaptionWidth
	Output of the x-offset value of the label's string.

SoSFBool	outputInfoIsValid
	Flag to indicate whether the output info is valid.

SoSFBool	shouldShowLabelStringOfOutputInfoLabel
	Should the label string be hidden for the label.

Public Attributes inherited from SoCSOEditorExtension
SoSFString	extensionId
	ID for a editor, needs to be unique per editor extension instance.

SoSFBool	allowCreation
	Shall the editor allow creation?

SoSFBool	allowModification
	Shall the editor allow modification of CSOs of its type?

SoSFBool	allowSeedPointInteraction
	Should the interaction with seed points be allowed?

SoSFBool	shouldRender
	Shall the editor render its CSOs?

SoSFMLBase	inVisualizationSettings
	Optionally attached visualization settings, overrides the vis.

SoSFEnum	selectionCursor

SoSFEnum	interactionForbiddenCursor

SoSFInt32	csoIdUnderMouseCursor
	The ID of the CSO currently under the mouse (or -1 if no CSO is under the mouse).

Protected Member Functions
	~SoCSOLabelRenderer () override
	Destructor.

Protected Member Functions inherited from SoCSOEditorExtension
	SoCSOEditorExtension ()
	Hidden constructor.

	~SoCSOEditorExtension () override
	Hidden destructor.

virtual void	initMembers ()

void	sendCSONotificationRepaint ()
	Sends a CSO notification to repaint the CSOList.

void	sendCSONotificationMove ()
	Sends a CSO notification on moving a CSO or seed point.

void	sendCSONotificationFinishInteraction ()
	Sends a CSO notification on finishing an interaction with a CSO.

void	sendCSONotificationResetInteractionState ()
	Sends a CSO notification on having the interaction state being reset.

void	sendCSONotificationInsertSeedPoint ()
	Sends a CSO notification on inserting a seed point.

void	sendCSONotificationNewCSOStarted ()
	Sends a CSO notification on having started to create a new CSO.

void	setExtensionIdAsSubType ()
	Sets the subtype member to the value of the extension ID string.

virtual void	setCreationData (const SoPointerPosition &pos, ml::CSO *newCSO)
	Sets creation data to a newly created CSO.

void	extensionIdCB (SoField *)

SoCSOEditorTools::LineRenderSettings	getLineRenderSettingsOnSlice ()
	Creates a LineRenderSettings struct from the editors visualization settings "onSlice" section.

SoCSOEditorTools::LineRenderSettings	getLineRenderSettingsForCSO (ml::CSO *cso)
	Creates a LineRenderSettings struct from the visualization attributes of the given CSO.

void	drawPathPoints (const CSODrawCSOInfos &csoInfos, const CSODrawView2DInfos &view2DInfos, const CSODrawSliceInformation &drawSliceInfo, const SbVec2f &shadowOffsetDevice, SoView2DCSOExtensibleEditor *editor)
	Draws the CSO by drawing lines between the path points. Renders different types of CSOs.

void	renderPathPoints (const CSOPathPointsRenderSettings &renderSettings, const CSODrawCSOInfos &csoInfos, const CSODrawView2DInfos &view2DInfos, const std::vector< CSOSliceCrossing > &pathPointsLists, GLint lineMode, const SbVec2f &shadowOffsetDevice)
	Draws path points with given render settings.

void	drawPathAndCrossingPoints (const CSODrawCSOInfos &csoInfos, const CSODrawView2DInfos &view2DInfos, const SbVec2f &shadowOffsetDevice, const std::vector< CSOSliceCrossing > &pathAndCrossingPoints, GLint lineMode)
	Draws the path and crossing points.

void	drawShape (int style, SoView2DCSOExtensibleEditor editor, ml::CSOVisualizationSettings visualizationSettings, float deviceX, float deviceY, float size, float lineWidth=1.f)
	Draws the shape with the given style with the given center and size.

void	drawSeedPoints (const CSODrawCSOInfos &csoInfos, const CSODrawView2DInfos &view2DInfos, const CSODrawSliceInformation &drawSliceInfo, SoView2DCSOExtensibleEditor *editor)
	Draws the seed points of the CSO.

void	drawFixedSizeCircleAt (float deviceX, float deviceY)
	Renders a fixed size circle at the given position.

bool	isCSOVisible (const CSODrawCSOInfos &csoInfos, const CSODrawView2DInfos &view2DInfos, const CSODrawSliceInformation &drawSliceInfo, SoView2DCSOExtensibleEditor *editor)
	Returns whether the CSO is visible on the current slice.

void	mapWorldToDevice (const SoPointerPosition &pos, const ml::Vector3 &worldPosition, float &deviceX, float &deviceY)
	Returns device coordinates for a given world position.

void	mapWorldToDevice (View2DSliceList *slicelist, const ml::Vector3 &worldPosition, float &deviceX, float &deviceY)
	Returns device coordinates for a given world position.

ml::Vector3	mapDeviceToWorld (const SoPointerPosition &pos, float deviceX, float deviceY)
	Returns world coordinates for given device position.

ml::Vector3	mapWorldToVoxel (const SoPointerPosition &pos, const ml::Vector3 &worldPosition)
	Returns a voxel position for a given world position.

ml::Vector3	mapWorldToVoxel (const SoPointerPosition &pos, const SbVec3f &worldPosition)
	Returns a voxel position for a given world position.

ml::Vector3	mapVoxelToWorld (const SoPointerPosition &pos, const ml::Vector3 &voxelPosition)
	Returns a world position for a given voxel position.

SbVec2f	nonShadowOffset () const
	Returns the default offset for non-shadows in pixels.

SbVec2f	shadowOffset () const
	Returns the default offset for shadows in pixels.

GLint	getLineMode (ml::CSO *cso)
	Returns the correct line mode for open and for closed CSOs.

void	setupGLForCSO (const CSODrawCSOInfos &csoInfos)
	Sets up GL state for color, line width, and point size.

void	setupGLShadow (float generalAlpha=1.0f)
	Sets up the GL state for shadow rendering (color and line width).

void	glSetAlpha (float alpha)
	Sets an alpha value but retains the set color.

float	getDepthAlpha (int maxSliceDistance, int currentSliceDistance) const
	Returns an alpha factor based on the max distance and the current distance.

bool	doesCSOTimePointMatchCurrentTimePoint (const CSODrawView2DInfos &view2DInfos, ml::CSO *cso)
	Returns true if the CSO's time point matches the (overwritten) current time point.

Friends
class	ml::CSOLabelPlacement

Additional Inherited Members
Protected Attributes inherited from SoCSOEditorExtension
SoView2DCSOExtensibleEditor *	_editor

ml::CSOListPtr	_hitCSOList
	Pointer to internal/interactive states.

ml::CSO *	_hitCSO

ml::CSOSeedPoint *	_hitSeedPoint

ml::CSOPathPoints *	_hitPathPoints

float	_hitDistance

ml::CSO *	_csoUnderMouse

ml::CSOVisualizationSettings	_visualizationSettings
	Default visual settings. Access them via the method getVisualSettings().

SbString	_subType
	Member for subtype of generated CSOs.

Detailed Description

Extension for rendering labels for CSOs.

Definition at line 45 of file SoCSOLabelRenderer.h.

Constructor & Destructor Documentation

◆ SoCSOLabelRenderer()

SoCSOLabelRenderer::SoCSOLabelRenderer ( )

Standard constructor.

◆ ~SoCSOLabelRenderer()

SoCSOLabelRenderer::~SoCSOLabelRenderer ( )

overrideprotected

Destructor.

Member Function Documentation

◆ computeOutputInformation()

void SoCSOLabelRenderer::computeOutputInformation ( )

Fills output information fields for a CSO on a viewer.

◆ createDragMoveTo()

void SoCSOLabelRenderer::createDragMoveTo ( const SoPointerPosition & )

inlineoverridevirtual

Implements SoCSOEditorExtension.

Definition at line 86 of file SoCSOLabelRenderer.h.

◆ createEndPress()

bool SoCSOLabelRenderer::createEndPress ( int )

inlineoverridevirtual

Implements SoCSOEditorExtension.

Definition at line 87 of file SoCSOLabelRenderer.h.

◆ createStartPressAt()

void SoCSOLabelRenderer::createStartPressAt ( const SoPointerPosition & )

inlineoverridevirtual

Implements SoCSOEditorExtension.

Definition at line 85 of file SoCSOLabelRenderer.h.

◆ cursorShape()

int SoCSOLabelRenderer::cursorShape ( ) const

inlineoverridevirtual

Returns the cursor shape that indicates the next creation.

Reimplemented from SoCSOEditorExtension.

Definition at line 97 of file SoCSOLabelRenderer.h.

References SoViewerProxy::DEFAULT_CURSOR.

◆ draw()

void SoCSOLabelRenderer::draw	(	const CSODrawCSOInfos &	csoInfos,
		const CSODrawView2DInfos &	view2DInfos,
		const CSODrawSliceInformation &	drawSliceInfo,
		SoView2DCSOExtensibleEditor *	editor
	)

overridevirtual

Drawing routine.

Reimplemented from SoCSOEditorExtension.

◆ drawOverlay()

void SoCSOLabelRenderer::drawOverlay	(	const CSODrawCSOInfos &	csoInfos,
		const CSODrawView2DInfos &	view2DInfos,
		const CSODrawSliceInformation &	sliceInfo,
		SoView2DCSOExtensibleEditor *	editor
	)

overridevirtual

Routine for drawing after the main routine has drawn.

Use this for geometry depending on the CSO that needs to be drawn over what 'draw' has rendered.

Reimplemented from SoCSOEditorExtension.

◆ drawSecondPass()

void SoCSOLabelRenderer::drawSecondPass	(	const CSODrawCSOInfos &	csoInfos,
		const CSODrawView2DInfos &	view2DInfos,
		const CSODrawSliceInformation &	sliceInfo,
		SoView2DCSOExtensibleEditor *	editor
	)

overridevirtual

Drawing routine that comes between 'main' and 'overlay'.

Reimplemented from SoCSOEditorExtension.

◆ getHitResizeHandler()

ml::CSO * SoCSOLabelRenderer::getHitResizeHandler	(	const std::string &	currentViewerId,
		const SoPointerPosition &	pos,
		int &	resizeHandlerCode
	)

Returns the pointer to a CSO whose label is on the given viewer under the given position. Fills up the hit resize handler code.

◆ getLabelCSO()

ml::CSO * SoCSOLabelRenderer::getLabelCSO	(	const std::string &	currentViewerId,
		const SoPointerPosition &	pos
	)

Returns the pointer to a CSO whose label is on the given viewer under the given position.

◆ initClass()

static void SoCSOLabelRenderer::initClass ( )

static

init class in inventor runtime

◆ isModificationEditor()

bool SoCSOLabelRenderer::isModificationEditor ( ) const

inlineoverridevirtual

Returns whether the editor is a modification editor.

Reimplemented from SoCSOEditorExtension.

Definition at line 71 of file SoCSOLabelRenderer.h.

◆ labelMoveDragMoveTo()

void SoCSOLabelRenderer::labelMoveDragMoveTo	(	ml::CSO *	cso,
		const SoPointerPosition &	pos
	)

◆ labelMoveEndPress()

SoPointingAction * SoCSOLabelRenderer::labelMoveEndPress	(	ml::CSO *	cso,
		int	clickCount
	)

◆ labelMoveStartPressAt()

void SoCSOLabelRenderer::labelMoveStartPressAt	(	ml::CSO *	cso,
		const SoPointerPosition &	pos
	)

◆ labelResizeDragMoveTo()

void SoCSOLabelRenderer::labelResizeDragMoveTo	(	ml::CSO *	cso,
		const SoPointerPosition &	pos,
		int	resizeHandlerCode
	)

◆ labelResizeEndPress()

SoPointingAction * SoCSOLabelRenderer::labelResizeEndPress	(	ml::CSO *	cso,
		int	clickCount
	)

◆ labelResizeStartPressAt()

void SoCSOLabelRenderer::labelResizeStartPressAt	(	ml::CSO *	cso,
		const SoPointerPosition &	pos
	)

◆ pointerLeftWindow()

void SoCSOLabelRenderer::pointerLeftWindow ( )

overridevirtual

Called when mouse pointer leaves the window.

Reimplemented from SoCSOEditorExtension.

◆ pointerPosition()

void SoCSOLabelRenderer::pointerPosition ( const SoPointerPosition & )

overridevirtual

Called when the mouse moves over a viewer.

Reimplemented from SoCSOEditorExtension.

◆ pointerPositionIfAllowedAt()

void SoCSOLabelRenderer::pointerPositionIfAllowedAt ( const SoPointerPosition & pos )

inlineoverridevirtual

Sets seed points while moving the mouse – but not while dragging.

Is called in isSensitiveAt only while interacting on the same slice where the interaction has started.

Implements SoCSOEditorExtension.

Definition at line 88 of file SoCSOLabelRenderer.h.

◆ resetCache()

void SoCSOLabelRenderer::resetCache ( )

overridevirtual

Resets the internal label string cache.

Reimplemented from SoCSOEditorExtension.

◆ selectAndMoveDragMoveTo()

void SoCSOLabelRenderer::selectAndMoveDragMoveTo ( const SoPointerPosition & )

inlineoverridevirtual

Implements SoCSOEditorExtension.

Definition at line 91 of file SoCSOLabelRenderer.h.

◆ selectAndMoveEndPress()

SoPointingAction * SoCSOLabelRenderer::selectAndMoveEndPress ( int )

inlineoverridevirtual

Implements SoCSOEditorExtension.

Definition at line 92 of file SoCSOLabelRenderer.h.

◆ selectAndMoveStartPressAt()

void SoCSOLabelRenderer::selectAndMoveStartPressAt ( const SoPointerPosition & )

inlineoverridevirtual

Implements SoCSOEditorExtension.

Definition at line 90 of file SoCSOLabelRenderer.h.

◆ setLabelUnderMouseForHighlighting()

void SoCSOLabelRenderer::setLabelUnderMouseForHighlighting ( ml::CSO * cso )

Sets the label for the given CSO as being under the mouse for highlighting.

◆ setLabelUnderMouseForInteraction()

void SoCSOLabelRenderer::setLabelUnderMouseForInteraction ( ml::CSO * cso )

Sets the label for the given CSO as being under the mouse for interaction (select, move, resize).

◆ setOuterModule()

void SoCSOLabelRenderer::setOuterModule ( ml::CSOLabelRenderer * labelRendererModule )

inline

Sets a pointer to the 'outer' module.

Definition at line 115 of file SoCSOLabelRenderer.h.

◆ setVisibleCSOs()

void SoCSOLabelRenderer::setVisibleCSOs	(	const std::vector< CSODrawCSOInfos > &	drawCSOInformation,
		const CSODrawView2DInfos &	view2DInfos,
		SoView2DCSOExtensibleEditor *	editor
	)

overridevirtual

Set information about all the CSOs that are to be rendered.

Reimplemented from SoCSOEditorExtension.

◆ shouldRenderGeneral()

bool SoCSOLabelRenderer::shouldRenderGeneral ( ml::CSO * ) const

inlineoverridevirtual

Returns whether a given CSO should be rendered by this general extension.

Overwrite this in general renderers.

Reimplemented from SoCSOEditorExtension.

Definition at line 104 of file SoCSOLabelRenderer.h.

◆ startDrawing()

void SoCSOLabelRenderer::startDrawing ( View2DSliceList * )

overridevirtual

Is called before drawing.

Reimplemented from SoCSOEditorExtension.

◆ updateStringsInCache()

void SoCSOLabelRenderer::updateStringsInCache ( )

Updates all label strings in the cache.

Friends And Related Symbol Documentation

◆ ml::CSOLabelPlacement

friend class ml::CSOLabelPlacement

friend

Definition at line 394 of file SoCSOLabelRenderer.h.

Member Data Documentation

◆ allowLabelResize

SoSFBool SoCSOLabelRenderer::allowLabelResize

Shall the user be allowed to resize a label?

Definition at line 146 of file SoCSOLabelRenderer.h.

◆ connectingLineAlpha

SoSFFloat SoCSOLabelRenderer::connectingLineAlpha

Global alpha factor that is multiplied to the local alpha factor of connecting lines.

Definition at line 144 of file SoCSOLabelRenderer.h.

◆ detachedLabelPlacement

SoSFEnum SoCSOLabelRenderer::detachedLabelPlacement

Positioning strategy for detached (manually moved) labels.

Definition at line 162 of file SoCSOLabelRenderer.h.

◆ drawConnectingLineToCenterOfCSO

SoSFBool SoCSOLabelRenderer::drawConnectingLineToCenterOfCSO

Shall the connecting line be drawn to th center of a CSO? Or to the nearest point on the CSO?

Definition at line 153 of file SoCSOLabelRenderer.h.

◆ drawLabelBorderForSelectedCSO

SoSFBool SoCSOLabelRenderer::drawLabelBorderForSelectedCSO

Shall a border be drawn around the label of a selected CSO?

Definition at line 134 of file SoCSOLabelRenderer.h.

◆ fontSize

SoSFInt32 SoCSOLabelRenderer::fontSize

Sets the font size of the text.

Definition at line 157 of file SoCSOLabelRenderer.h.

◆ inLabelPlacement

SoSFMLBase SoCSOLabelRenderer::inLabelPlacement

Option input of label placement.

Definition at line 127 of file SoCSOLabelRenderer.h.

◆ inputInfoCSOId

SoSFInt32 SoCSOLabelRenderer::inputInfoCSOId

Trade interface for retrieving the device position (and other information) of a label on a certain viewer.

Input of the CSO id.

Definition at line 169 of file SoCSOLabelRenderer.h.

◆ inputInfoViewerId

SoSFString SoCSOLabelRenderer::inputInfoViewerId

Input of the viewer id string.

Definition at line 171 of file SoCSOLabelRenderer.h.

◆ labelBorderMarginX

SoSFInt32 SoCSOLabelRenderer::labelBorderMarginX

Sets the inner margin of the label border in x-direction.

Definition at line 130 of file SoCSOLabelRenderer.h.

◆ labelBorderMarginY

SoSFInt32 SoCSOLabelRenderer::labelBorderMarginY

Sets the inner margin of the label border in y-direction.

Definition at line 132 of file SoCSOLabelRenderer.h.

◆ minConnectingLineLength

SoSFInt32 SoCSOLabelRenderer::minConnectingLineLength

The minimum length of a connecting line to get drawn (in pixel).

Definition at line 150 of file SoCSOLabelRenderer.h.

◆ movePerformCursor

SoSFEnum SoCSOLabelRenderer::movePerformCursor

Definition at line 191 of file SoCSOLabelRenderer.h.

◆ movePossibleCursor

SoSFEnum SoCSOLabelRenderer::movePossibleCursor

Definition at line 190 of file SoCSOLabelRenderer.h.

◆ outputInfoIsValid

SoSFBool SoCSOLabelRenderer::outputInfoIsValid

Flag to indicate whether the output info is valid.

Definition at line 184 of file SoCSOLabelRenderer.h.

◆ outputInfoLabelBoundingBoxEnd

SoSFVec2f SoCSOLabelRenderer::outputInfoLabelBoundingBoxEnd

Output of the lower right corner of the label's bounding box.

Definition at line 176 of file SoCSOLabelRenderer.h.

◆ outputInfoLabelBoundingBoxStart

SoSFVec2f SoCSOLabelRenderer::outputInfoLabelBoundingBoxStart

Output of the upper left corner of the label's bounding box.

Definition at line 174 of file SoCSOLabelRenderer.h.

◆ outputInfoLabelCaption

SoSFString SoCSOLabelRenderer::outputInfoLabelCaption

Output of the label's caption.

Definition at line 178 of file SoCSOLabelRenderer.h.

◆ outputInfoLabelCaptionWidth

SoSFInt32 SoCSOLabelRenderer::outputInfoLabelCaptionWidth

Output of the x-offset value of the label's string.

Definition at line 182 of file SoCSOLabelRenderer.h.

◆ outputInfoLabelString

SoSFString SoCSOLabelRenderer::outputInfoLabelString

Output of the label's string.

Definition at line 180 of file SoCSOLabelRenderer.h.

◆ repaintTrigger

SoSFTrigger SoCSOLabelRenderer::repaintTrigger

Just a dummy field to trigger a repaint.

Definition at line 155 of file SoCSOLabelRenderer.h.

◆ scaleECursor

SoSFEnum SoCSOLabelRenderer::scaleECursor

Definition at line 199 of file SoCSOLabelRenderer.h.

◆ scaleNCursor

SoSFEnum SoCSOLabelRenderer::scaleNCursor

Definition at line 193 of file SoCSOLabelRenderer.h.

◆ scaleNECursor

SoSFEnum SoCSOLabelRenderer::scaleNECursor

Definition at line 200 of file SoCSOLabelRenderer.h.

◆ scaleNWCursor

SoSFEnum SoCSOLabelRenderer::scaleNWCursor

Definition at line 194 of file SoCSOLabelRenderer.h.

◆ scaleSCursor

SoSFEnum SoCSOLabelRenderer::scaleSCursor

Definition at line 197 of file SoCSOLabelRenderer.h.

◆ scaleSECursor

SoSFEnum SoCSOLabelRenderer::scaleSECursor

Definition at line 198 of file SoCSOLabelRenderer.h.

◆ scaleSWCursor

SoSFEnum SoCSOLabelRenderer::scaleSWCursor

Definition at line 196 of file SoCSOLabelRenderer.h.

◆ scaleWCursor

SoSFEnum SoCSOLabelRenderer::scaleWCursor

Definition at line 195 of file SoCSOLabelRenderer.h.

◆ shouldDrawConnectingLine

SoSFBool SoCSOLabelRenderer::shouldDrawConnectingLine

Shall a connecting line between the label and the CSO be drawn?

Definition at line 139 of file SoCSOLabelRenderer.h.

◆ shouldDrawResizeHandlers

SoSFBool SoCSOLabelRenderer::shouldDrawResizeHandlers

Shall resize handlers be drawn?

Definition at line 148 of file SoCSOLabelRenderer.h.

◆ shouldHighlightBorderOnMouseOver

SoSFBool SoCSOLabelRenderer::shouldHighlightBorderOnMouseOver

Shall the label's border be highlighted on mouse over?

Definition at line 141 of file SoCSOLabelRenderer.h.

◆ shouldRenderLabelName

SoSFBool SoCSOLabelRenderer::shouldRenderLabelName

Shall the label name be rendered at the CSO when the label has been moved away?

Definition at line 137 of file SoCSOLabelRenderer.h.

◆ shouldShowLabelStringOfOutputInfoLabel

SoSFBool SoCSOLabelRenderer::shouldShowLabelStringOfOutputInfoLabel

Should the label string be hidden for the label.

Definition at line 186 of file SoCSOLabelRenderer.h.

◆ tryToPlaceLabelsWithoutOverlap

SoSFBool SoCSOLabelRenderer::tryToPlaceLabelsWithoutOverlap

Should the renderer attempt to place a label without overlapping other labels?

Definition at line 160 of file SoCSOLabelRenderer.h.

◆ viewerBorderHandling

SoSFEnum SoCSOLabelRenderer::viewerBorderHandling

Handling of labels that move over the viewer's border.

Definition at line 164 of file SoCSOLabelRenderer.h.

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

MeVisLab/Standard/Sources/Inventor/SoCSO/SoView2DCSOEditor/SoView2DCSOExtensibleEditor/extensions/SoCSOLabelRenderer/SoCSOLabelRenderer.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoCSOLabelRenderer()

◆ ~SoCSOLabelRenderer()

Member Function Documentation

◆ computeOutputInformation()

◆ createDragMoveTo()

◆ createEndPress()

◆ createStartPressAt()

◆ cursorShape()

◆ draw()

◆ drawOverlay()

◆ drawSecondPass()

◆ getHitResizeHandler()

◆ getLabelCSO()

◆ initClass()

◆ isModificationEditor()

◆ labelMoveDragMoveTo()

◆ labelMoveEndPress()

◆ labelMoveStartPressAt()

◆ labelResizeDragMoveTo()

◆ labelResizeEndPress()

◆ labelResizeStartPressAt()

◆ pointerLeftWindow()

◆ pointerPosition()

◆ pointerPositionIfAllowedAt()

◆ resetCache()

◆ selectAndMoveDragMoveTo()

◆ selectAndMoveEndPress()

◆ selectAndMoveStartPressAt()

◆ setLabelUnderMouseForHighlighting()

◆ setLabelUnderMouseForInteraction()

◆ setOuterModule()

◆ setVisibleCSOs()

◆ shouldRenderGeneral()

◆ startDrawing()

◆ updateStringsInCache()

Friends And Related Symbol Documentation

◆ ml::CSOLabelPlacement

Member Data Documentation

◆ allowLabelResize

◆ connectingLineAlpha

◆ detachedLabelPlacement

◆ drawConnectingLineToCenterOfCSO

◆ drawLabelBorderForSelectedCSO

◆ fontSize

◆ inLabelPlacement

◆ inputInfoCSOId

◆ inputInfoViewerId

◆ labelBorderMarginX

◆ labelBorderMarginY

◆ minConnectingLineLength

◆ movePerformCursor

◆ movePossibleCursor

◆ outputInfoIsValid

◆ outputInfoLabelBoundingBoxEnd

◆ outputInfoLabelBoundingBoxStart

◆ outputInfoLabelCaption

◆ outputInfoLabelCaptionWidth

◆ outputInfoLabelString

◆ repaintTrigger

◆ scaleECursor

◆ scaleNCursor

◆ scaleNECursor

◆ scaleNWCursor

◆ scaleSCursor

◆ scaleSECursor

◆ scaleSWCursor

◆ scaleWCursor

◆ shouldDrawConnectingLine

◆ shouldDrawResizeHandlers

◆ shouldHighlightBorderOnMouseOver

◆ shouldRenderLabelName

◆ shouldShowLabelStringOfOutputInfoLabel