Module for visualizing CSOs in 3D as an Open Inventor scene. More...

#include <SoCSO3DVis.h>

Inheritance diagram for SoCSO3DVis:

Public Member Functions
	SoCSO3DVis ()
	Standard constructor.

Public Member Functions inherited from SoInteractionNode
	SoInteractionNode ()
	Constructor.

	~SoInteractionNode () override

void	handleEvent (SoHandleEventAction *action) override
	Handles the mouse and keyboard events.

Public Member Functions inherited from SoInteractionProviderNode
	SoInteractionProviderNode ()
	Default constructor.

	~SoInteractionProviderNode () override
	Destructor.

std::string	getID () const override
	Returns the id string for identifying the provider (and its actions) - this is usually the name of the scene node.

void	objRef () override
	Memory management by reference counting; must be implemented in derived classes.

void	objUnref () override

Public Member Functions inherited from SoInteractionOwner
	SoInteractionOwner ()
	Default constructor.

	~SoInteractionOwner () override
	The destructor will destroy all interactions created with this object as owner.

std::list< SoInteraction * >	getInteractions (SoState *state) override
	Returns the list of all interactions of this provider.

void	pointerPosition (SoState *state, const SoPointerPosition &pos) override
	Same as below, with additional SoState argument. Be defaults simply calls the below version.

void	pointerLeftWindow (SoState *state) override
	Same as below, with additional SoState argument. Be defaults simply calls the below version.

void	addListener (SoInteractionOwnerListenerInterface *listener)
	Add a listener object that is notified of changes in the interaction list.

void	removeListener (SoInteractionOwnerListenerInterface *listener)
	Remove a listener object that was notified of changes in the interaction list.

Public Member Functions inherited from SoInteractionProvider
	SoInteractionProvider ()
	Default constructor.

virtual	~SoInteractionProvider ()

template<class T >
std::list< T * >	getInteractionsOfType (SoState *state)
	Returns list of interactions of a specific type:

virtual std::list< SoCommandAction * >	getCommandActions (SoState *state)

virtual std::list< SoPointingAction * >	getPointingActions (SoState *state)

virtual std::list< SoOffsetAction * >	getOffsetActions (SoState *state)

Public Member Functions inherited from SoInteractionHandler
	SoInteractionHandler (SoInteractionProvider *provider)

virtual	~SoInteractionHandler ()

virtual void	handleEventForInteraction (SoHandleEventAction *action)
	Handles the mouse and keyboard events and send them to interaction nodes.

Static Public Member Functions
static void	initClass ()
	Initializes this class (inventor stuff)

Static Public Member Functions inherited from SoInteractionNode
static void	initClass ()
	Initializes this class.

static SoInteractionProvider *	getInteractionProvider (SoNode *node)

Static Public Member Functions inherited from SoInteractionProviderNode
static void	initClass ()
	Initializes this class.

Static Public Member Functions inherited from SoInteractionProvider
static void	registerInteractionProviderNode (SoType type, GetProviderFunc func)
	Register a function to obtain a SoInteractionProvider from a SoNode.

static SoInteractionProvider *	getInteractionProvider (SoNode *node)
	Get a SoInteractionProvider from a SoNode if registered, else NULL.

Public Attributes
SoSFMLBase	inCSOList
	The input CSOList.

SoSFMLBase	inStylePalette
	Input of a style palette.

SoSFMLBase	inVisualizationSettings
	Input for a CSOVisualizationSettings object.

SoSFMLBase	inLUT
	LUT for coloring of path points.

SoSFBool	autoApply
	Shall all changes of parameters take immediate effect?

SoSFTrigger	apply
	Applies changes.

SoSFBool	enableSelection
	Should the selection be enabled?

SoSFBool	performPreHitTest
	Perform picking while hovering.

SoSFEnum	cursorShape
	Cursor shape for action.

SoSFBool	highlightSelectedGroups
	Should the module highlight all CSOs that are in selected Groups?

SoSFFloat	pathPointWidthOffset
	This value is added to all line widths as an offset.

SoSFFloat	seedPointSizeScaling
	This value is multiplied to all marker sizes as a scaling.

SoSFBool	useRenderTimeDelay
	If checked, the scene is rendered only after the adjustable time.

SoSFFloat	timerDelayMilliSeconds
	The adjustable timer delay.

SoSFBool	listenToRepaintNotifications
	Shall the module listen to every repaint notification?

SoSFBool	listenToFinishingNotifications
	Shall the module listen to finishing notifications?

SoSFBool	listenToSelectionChangedNotifications
	Shall the module listen to selection changed notifications?

SoSFBool	useStylePalette
	Should a style palette be used for adjusting display options if one is attached?

SoSFEnum	stylePaletteUseIndexAs
	Defines the use of style palette indices (CSO / Group).

SoSFBool	useLUT
	Should use 4th component in path points as (absolute) index into LUT supplied by inLUT input.

SoSFInt32	timepointToRender
	Defines which timepoint to render; -1 renders all XMarkers.

SoSFBool	provideVertexProperties
	Should texture coordinates and normals be provided in vertex properties?

Public Attributes inherited from SoInteractionProviderNode
SoSFString	instanceName
	Defines interface field to store the instance name.

SoSFString	interactionProviderID
	This field overrides the instanceName as providerID if specified.

Protected Member Functions
	~SoCSO3DVis () override
	Standard destructor.

Protected Member Functions inherited from SoInteractionOwner
virtual void	pointerPosition (const SoPointerPosition &)
	Override this if you always need to be informed of the current mouse cursor position.

virtual void	pointerLeftWindow ()
	This is called when the mouse cursor leaves the window.

bool	hasInteractions () const
	Returns whether there are any actions defined by this owner.

template<class T >
bool	hasInteractionsOfType () const
	Same as above, but asking for a specific type of interaction.

void	addPointingAction (SoPointingAction *)

void	addCommandAction (SoCommandAction *)

void	addOffsetAction (SoOffsetAction *)

Protected Member Functions inherited from SoInteractionHandler
bool	handleKeyPress (SoState *state, const SoPointerPosition &location, int modifiers, SoKeyboardEvent::Key nKey)
	Handles key press by checking for commands actions with matching key shortcuts and executing (one of) them.

virtual bool	augmentLocation (SoPointerPosition &, bool)
	This method can be overridden to provide further position information to SoPointingActions - e.g.

void	buttonMaskChanged (SoState *state, const SoPointerPosition &location, int buttonMask)
	Called if the button mask changed since the last input event.

void	modifierMaskChanged (SoState *state, const SoPointerPosition &location, int modifierMask)
	Called if the modifier mask changed since the last input event.

void	locationChanged (SoState *state, const SoPointerPosition &location, bool force=false, bool renderRefresh=false)
	Called if the pointer location changed since the last input event.

bool	wheelRotated (SoState *state, const SoPointerPosition &location, int modifierMask, SoMouseWheelEvent::Orientation orientation, short rotation)
	Called when the mouse wheel is rotated.

void	handlePointerLeftWindow (SoState *state)
	Called if the pointer left the scene widget.

SoInteractionCoordinator *	getCoordinator ()
	Access method, returns the interaction coordinator during event handling.

SoPointingAction *	getLocalCurrentPointingAction ()

virtual bool	isEnabled (SoPointingAction *action, int currentMask)
	This method returns true if the pointing action should be enabled for the given modifier/button mask.

virtual bool	isValidStartingLocation (const SoPointerPosition &location)
	This method returns whether the current location is valid for starting a pointing action.

bool	canSelectPointingAction ()

void	selectTargetPointingAction (SoState *state, const SoPointerPosition &location, int mask)

bool	trySwitchGlobalPointingAction (SoState *state, const SoPointerPosition &location, int buttonMask, int modifierMask)
	Tries to switch from one global pointing action to another during a drag.

int	getCurrentButtonMask ()

int	getCurrentModifierMask ()
	Returns the currently active button modifier.

SoPointerPosition	getCurrentPointerLocation ()
	Returns the current position of the mouse cursor.

bool	isCurrentPointerLocationValid ()
	Returns whether the current mouse cursor position is valid.

Friends
class	SoCSO3DVisPickAction

Additional Inherited Members
Public Types inherited from SoInteractionProvider
typedef SoInteractionProvider (	GetProviderFunc) (SoNode *)

Detailed Description

Module for visualizing CSOs in 3D as an Open Inventor scene.

Definition at line 34 of file SoCSO3DVis.h.

Constructor & Destructor Documentation

◆ SoCSO3DVis()

SoCSO3DVis::SoCSO3DVis ( )

Standard constructor.

◆ ~SoCSO3DVis()

SoCSO3DVis::~SoCSO3DVis ( )

overrideprotected

Standard destructor.

Member Function Documentation

◆ initClass()

static void SoCSO3DVis::initClass ( )

static

Initializes this class (inventor stuff)

Friends And Related Symbol Documentation

◆ SoCSO3DVisPickAction

friend class SoCSO3DVisPickAction

friend

Definition at line 36 of file SoCSO3DVis.h.

Member Data Documentation

◆ apply

SoSFTrigger SoCSO3DVis::apply

Applies changes.

Definition at line 60 of file SoCSO3DVis.h.

◆ autoApply

SoSFBool SoCSO3DVis::autoApply

Shall all changes of parameters take immediate effect?

Definition at line 58 of file SoCSO3DVis.h.

◆ cursorShape

SoSFEnum SoCSO3DVis::cursorShape

Cursor shape for action.

Definition at line 67 of file SoCSO3DVis.h.

◆ enableSelection

SoSFBool SoCSO3DVis::enableSelection

Should the selection be enabled?

Definition at line 63 of file SoCSO3DVis.h.

◆ highlightSelectedGroups

SoSFBool SoCSO3DVis::highlightSelectedGroups

Should the module highlight all CSOs that are in selected Groups?

Definition at line 69 of file SoCSO3DVis.h.

◆ inCSOList

SoSFMLBase SoCSO3DVis::inCSOList

The input CSOList.

Definition at line 49 of file SoCSO3DVis.h.

◆ inLUT

SoSFMLBase SoCSO3DVis::inLUT

LUT for coloring of path points.

Definition at line 55 of file SoCSO3DVis.h.

◆ inStylePalette

SoSFMLBase SoCSO3DVis::inStylePalette

Input of a style palette.

Definition at line 51 of file SoCSO3DVis.h.

◆ inVisualizationSettings

SoSFMLBase SoCSO3DVis::inVisualizationSettings

Input for a CSOVisualizationSettings object.

Definition at line 53 of file SoCSO3DVis.h.

◆ listenToFinishingNotifications

SoSFBool SoCSO3DVis::listenToFinishingNotifications

Shall the module listen to finishing notifications?

Definition at line 81 of file SoCSO3DVis.h.

◆ listenToRepaintNotifications

SoSFBool SoCSO3DVis::listenToRepaintNotifications

Shall the module listen to every repaint notification?

Definition at line 79 of file SoCSO3DVis.h.

◆ listenToSelectionChangedNotifications

SoSFBool SoCSO3DVis::listenToSelectionChangedNotifications

Shall the module listen to selection changed notifications?

Definition at line 83 of file SoCSO3DVis.h.

◆ pathPointWidthOffset

SoSFFloat SoCSO3DVis::pathPointWidthOffset

This value is added to all line widths as an offset.

Definition at line 71 of file SoCSO3DVis.h.

◆ performPreHitTest

SoSFBool SoCSO3DVis::performPreHitTest

Perform picking while hovering.

Definition at line 65 of file SoCSO3DVis.h.

◆ provideVertexProperties

SoSFBool SoCSO3DVis::provideVertexProperties

Should texture coordinates and normals be provided in vertex properties?

Definition at line 98 of file SoCSO3DVis.h.

◆ seedPointSizeScaling

SoSFFloat SoCSO3DVis::seedPointSizeScaling

This value is multiplied to all marker sizes as a scaling.

Definition at line 73 of file SoCSO3DVis.h.

◆ stylePaletteUseIndexAs

SoSFEnum SoCSO3DVis::stylePaletteUseIndexAs

Defines the use of style palette indices (CSO / Group).

Definition at line 88 of file SoCSO3DVis.h.

◆ timepointToRender

SoSFInt32 SoCSO3DVis::timepointToRender

Defines which timepoint to render; -1 renders all XMarkers.

Definition at line 95 of file SoCSO3DVis.h.

◆ timerDelayMilliSeconds

SoSFFloat SoCSO3DVis::timerDelayMilliSeconds

The adjustable timer delay.

Definition at line 77 of file SoCSO3DVis.h.

◆ useLUT

SoSFBool SoCSO3DVis::useLUT

Should use 4th component in path points as (absolute) index into LUT supplied by inLUT input.

The resulting value is blended over the unmodified color/alpha.

Definition at line 92 of file SoCSO3DVis.h.

◆ useRenderTimeDelay

SoSFBool SoCSO3DVis::useRenderTimeDelay

If checked, the scene is rendered only after the adjustable time.

Definition at line 75 of file SoCSO3DVis.h.

◆ useStylePalette

SoSFBool SoCSO3DVis::useStylePalette

Should a style palette be used for adjusting display options if one is attached?

Definition at line 86 of file SoCSO3DVis.h.

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

MeVisLab/Standard/Sources/Inventor/SoCSO/SoCSO3DVis/SoCSO3DVis.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Friends

Additional Inherited Members