SoView2DCSOEditorBase Class Reference

#include <SoView2DCSOEditorBase.h>

Inheritance diagram for SoView2DCSOEditorBase:

List of all members.

Public Member Functions
	SoView2DCSOEditorBase ()
	Default constructor.
void	setUpVisualization (ml::CSOList *csoList, ml::CSO *cso, const CSOEditorState &editorState, ml::StylePalette *stylePalette, CSOVisualParameters &visualParameters)
	Sets up CSO visualization parameters for the given CSO.
int	getStylePaletteIndex (const ml::CSO *cso, ml::StylePalette *stylePalette) const
	Returns the index into the StylePalette depending on the module's settings.
int	evaluateHitPoint (View2DSliceList *slicelist, const ml::Vector3 &currentHitPoint, const ml::CSOList *csoList, const std::string &editorId, const ml::CSOBoundingBox &slabBB, int pickingMode, ml::CSO *&hitCSO, ml::CSOSeedPoint *&hitSeedPoint, ml::CSOPathPoints *&hitPathPoints, float &distance)
	Checks for hits of the given point with a CSO and returns the hit mode.
bool	isEditable (const ml::CSO *cso, View2DSliceList *slicelist, int currentSlice) const
	Returns whether the given CSO is editable.
virtual int	getTimePoint (View2DSliceList *slicelist, int slice) const
	Returns the current timepoint which is either the actual shown timepoint or the timepoint overwritten by the field overwriteTimePoint; The slice parameter is not used in the standard implementation but can be necessary in derived classes.
bool	shouldSkipCSOOnSlice (ml::CSO *cso, View2DSliceList *slicelist, int z)
	Returns whether the given CSO should be skipped (rendering, interacting with) on the given slice.
bool	getHitCoordinates (View2DSliceList *slicelist, View2DEvent *ec, const ml::CSOBoundingBox &slabBB, ml::Vector3 &hitPoint)
	Fills up a hit point with world coordinates and returns true if the image was hit.
void	setUpIcons ()
	Sets up the internal icon list from an external icon file.
void	drawSeedPoints (CSOVisualParameters &visualParameters, const CSODrawCSOInfos &csoInfos, const CSODrawView2DInfos &view2DInfos, ml::CSOSeedPoint *underCursorSeedPoint, SoView2DExtension *extension, bool useIcons) const
	Renders seed points of the given CSO.
void	drawSeedPoints (CSOVisualParameters &visualParameters, ml::CSO *cso, const CSODrawCSOInfos &csoInfos, const CSODrawView2DInfos &view2DInfos, ml::CSOSeedPoint *underCursorSeedPoint, SoView2DExtension *extension, bool useIcons) const
	Renders seed points of the given CSO.
Protected Member Functions
	~SoView2DCSOEditorBase ()
	Destructor.
virtual bool	getShouldOnlyInteractWithSelectedCSO () const =0
	pure virtual access methods to fields every editor needs to implement
virtual float	getSelectionTolerance () const =0
virtual bool	getShowOnlyParallelCSOs () const =0
virtual bool	getShowCSOsOnAllTimePoints () const =0
virtual bool	getOverwriteCurrentTimePoint () const =0
virtual int	getNewCurrentTimePoint () const =0
virtual float	getShowParallelThickness () const =0
virtual bool	getUseStylePalette () const =0
virtual float	getGlobalAlphaFactor () const =0
virtual int	getStylePaletteUseIndexAs () const =0
virtual bool	getUseIconFile () const =0
virtual SbString	getIconFile () const =0
virtual SbString	getInternalIconFile () const =0
virtual bool	getHighlightSelectedGroups () const =0
virtual bool	getOverwriteSelectionVisualizationSettings () const =0
virtual int	getSelectionColoringMode () const =0
virtual float	getSelectionBrightenColor () const =0
virtual SbColor	getSelectionFixedColor () const =0
virtual int	getSelectionLineWidthMode () const =0
virtual float	getSelectionWidenLineWidth () const =0
virtual float	getSelectionFixedLineWidth () const =0
virtual int	getSelectedSeedPointColoringMode () const =0
virtual int	getSelectedSeedPointSizeMode () const =0
virtual float	getSelectedSeedPointBrightenColor () const =0
virtual float	getSelectedSeedPointAlpha () const =0
virtual SbColor	getSelectedSeedPointFixedColor () const =0
virtual float	getSelectedSeedPointEnlargeSize () const =0
virtual float	getSelectedSeedPointSize () const =0
virtual bool	getEnableMouseOverHighlighting () const =0
virtual int	getMouseOverColorMode () const =0
virtual SbColor	getMouseOverColorColor () const =0
virtual float	getMouseOverColorBrightenValue () const =0
virtual int	getMouseOverLineWidthMode () const =0
virtual float	getMouseOverLineWidthLineWidth () const =0
virtual float	getMouseOverLineWidthWidenValue () const =0
virtual bool	getUsePathPointColorForSeedPoints () const =0
virtual bool	getShowSeedPoints () const =0
virtual int	getLabelColorMode () const =0
virtual SbColor	getGeneralLabelColor () const =0
virtual float	getGeneralLabelAlpha () const =0
Protected Attributes
View2DIcons *	_icons
	A pointer to the 2D icons.

---

Detailed Description

Definition at line 35 of file SoView2DCSOEditorBase.h.

---

Constructor & Destructor Documentation

SoView2DCSOEditorBase::SoView2DCSOEditorBase

(

)

Default constructor.

SoView2DCSOEditorBase::~SoView2DCSOEditorBase

(

)

[protected]

Destructor.

---

Member Function Documentation

void SoView2DCSOEditorBase::drawSeedPoints	(	CSOVisualParameters &	visualParameters,
		const CSODrawCSOInfos &	csoInfos,
		const CSODrawView2DInfos &	view2DInfos,
		ml::CSOSeedPoint *	underCursorSeedPoint,
		SoView2DExtension *	extension,
		bool	useIcons
	)		const

Renders seed points of the given CSO.

void SoView2DCSOEditorBase::drawSeedPoints	(	CSOVisualParameters &	visualParameters,
		ml::CSO *	cso,
		const CSODrawCSOInfos &	csoInfos,
		const CSODrawView2DInfos &	view2DInfos,
		ml::CSOSeedPoint *	underCursorSeedPoint,
		SoView2DExtension *	extension,
		bool	useIcons
	)		const

Renders seed points of the given CSO.

int SoView2DCSOEditorBase::evaluateHitPoint	(	View2DSliceList *	slicelist,
		const ml::Vector3 &	currentHitPoint,
		const ml::CSOList *	csoList,
		const std::string &	editorId,
		const ml::CSOBoundingBox &	slabBB,
		int	pickingMode,
		ml::CSO *&	hitCSO,
		ml::CSOSeedPoint *&	hitSeedPoint,
		ml::CSOPathPoints *&	hitPathPoints,
		float &	distance
	)

Checks for hits of the given point with a CSO and returns the hit mode.

virtual bool SoView2DCSOEditorBase::getEnableMouseOverHighlighting

(

)

const [protected, pure virtual]

virtual float SoView2DCSOEditorBase::getGeneralLabelAlpha

(

)

const [protected, pure virtual]

virtual SbColor SoView2DCSOEditorBase::getGeneralLabelColor

(

)

const [protected, pure virtual]

virtual float SoView2DCSOEditorBase::getGlobalAlphaFactor

(

)

const [protected, pure virtual]

virtual bool SoView2DCSOEditorBase::getHighlightSelectedGroups

(

)

const [protected, pure virtual]

bool SoView2DCSOEditorBase::getHitCoordinates	(	View2DSliceList *	slicelist,
		View2DEvent *	ec,
		const ml::CSOBoundingBox &	slabBB,
		ml::Vector3 &	hitPoint
	)

Fills up a hit point with world coordinates and returns true if the image was hit.

Return whether the valid image region was hit.

virtual SbString SoView2DCSOEditorBase::getIconFile

(

)

const [protected, pure virtual]

virtual SbString SoView2DCSOEditorBase::getInternalIconFile

(

)

const [protected, pure virtual]

virtual int SoView2DCSOEditorBase::getLabelColorMode

(

)

const [protected, pure virtual]

virtual float SoView2DCSOEditorBase::getMouseOverColorBrightenValue

(

)

const [protected, pure virtual]

virtual SbColor SoView2DCSOEditorBase::getMouseOverColorColor

(

)

const [protected, pure virtual]

virtual int SoView2DCSOEditorBase::getMouseOverColorMode

(

)

const [protected, pure virtual]

virtual float SoView2DCSOEditorBase::getMouseOverLineWidthLineWidth

(

)

const [protected, pure virtual]

virtual int SoView2DCSOEditorBase::getMouseOverLineWidthMode

(

)

const [protected, pure virtual]

virtual float SoView2DCSOEditorBase::getMouseOverLineWidthWidenValue

(

)

const [protected, pure virtual]

virtual int SoView2DCSOEditorBase::getNewCurrentTimePoint

(

)

const [protected, pure virtual]

virtual bool SoView2DCSOEditorBase::getOverwriteCurrentTimePoint

(

)

const [protected, pure virtual]

virtual bool SoView2DCSOEditorBase::getOverwriteSelectionVisualizationSettings

(

)

const [protected, pure virtual]

virtual float SoView2DCSOEditorBase::getSelectedSeedPointAlpha

(

)

const [protected, pure virtual]

virtual float SoView2DCSOEditorBase::getSelectedSeedPointBrightenColor

(

)

const [protected, pure virtual]

virtual int SoView2DCSOEditorBase::getSelectedSeedPointColoringMode

(

)

const [protected, pure virtual]

virtual float SoView2DCSOEditorBase::getSelectedSeedPointEnlargeSize

(

)

const [protected, pure virtual]

virtual SbColor SoView2DCSOEditorBase::getSelectedSeedPointFixedColor

(

)

const [protected, pure virtual]

virtual float SoView2DCSOEditorBase::getSelectedSeedPointSize

(

)

const [protected, pure virtual]

virtual int SoView2DCSOEditorBase::getSelectedSeedPointSizeMode

(

)

const [protected, pure virtual]

virtual float SoView2DCSOEditorBase::getSelectionBrightenColor

(

)

const [protected, pure virtual]

virtual int SoView2DCSOEditorBase::getSelectionColoringMode

(

)

const [protected, pure virtual]

virtual SbColor SoView2DCSOEditorBase::getSelectionFixedColor

(

)

const [protected, pure virtual]

virtual float SoView2DCSOEditorBase::getSelectionFixedLineWidth

(

)

const [protected, pure virtual]

virtual int SoView2DCSOEditorBase::getSelectionLineWidthMode

(

)

const [protected, pure virtual]

virtual float SoView2DCSOEditorBase::getSelectionTolerance

(

)

const [protected, pure virtual]

virtual float SoView2DCSOEditorBase::getSelectionWidenLineWidth

(

)

const [protected, pure virtual]

virtual bool SoView2DCSOEditorBase::getShouldOnlyInteractWithSelectedCSO

(

)

const [protected, pure virtual]

pure virtual access methods to fields every editor needs to implement

virtual bool SoView2DCSOEditorBase::getShowCSOsOnAllTimePoints

(

)

const [protected, pure virtual]

virtual bool SoView2DCSOEditorBase::getShowOnlyParallelCSOs

(

)

const [protected, pure virtual]

virtual float SoView2DCSOEditorBase::getShowParallelThickness

(

)

const [protected, pure virtual]

virtual bool SoView2DCSOEditorBase::getShowSeedPoints

(

)

const [protected, pure virtual]

int SoView2DCSOEditorBase::getStylePaletteIndex	(	const ml::CSO *	cso,
		ml::StylePalette *	stylePalette
	)		const

Returns the index into the StylePalette depending on the module's settings.

virtual int SoView2DCSOEditorBase::getStylePaletteUseIndexAs

(

)

const [protected, pure virtual]

virtual int SoView2DCSOEditorBase::getTimePoint	(	View2DSliceList *	slicelist,
		int	slice
	)		const [virtual]

Returns the current timepoint which is either the actual shown timepoint or the timepoint overwritten by the field overwriteTimePoint; The slice parameter is not used in the standard implementation but can be necessary in derived classes.

virtual bool SoView2DCSOEditorBase::getUseIconFile

(

)

const [protected, pure virtual]

virtual bool SoView2DCSOEditorBase::getUsePathPointColorForSeedPoints

(

)

const [protected, pure virtual]

virtual bool SoView2DCSOEditorBase::getUseStylePalette

(

)

const [protected, pure virtual]

bool SoView2DCSOEditorBase::isEditable	(	const ml::CSO *	cso,
		View2DSliceList *	slicelist,
		int	currentSlice
	)		const

Returns whether the given CSO is editable.

void SoView2DCSOEditorBase::setUpIcons

(

)

Sets up the internal icon list from an external icon file.

void SoView2DCSOEditorBase::setUpVisualization	(	ml::CSOList *	csoList,
		ml::CSO *	cso,
		const CSOEditorState &	editorState,
		ml::StylePalette *	stylePalette,
		CSOVisualParameters &	visualParameters
	)

Sets up CSO visualization parameters for the given CSO.

bool SoView2DCSOEditorBase::shouldSkipCSOOnSlice	(	ml::CSO *	cso,
		View2DSliceList *	slicelist,
		int	z
	)

Returns whether the given CSO should be skipped (rendering, interacting with) on the given slice.

---

Member Data Documentation

View2DIcons* SoView2DCSOEditorBase::_icons [protected]

A pointer to the 2D icons.

Definition at line 81 of file SoView2DCSOEditorBase.h.

---

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

• MeVisLab/Standard/Sources/Inventor/SoCSO/SoView2DCSOEditor/SoView2DCSOEditorBase.h