SoCSODefines.h File Reference

#include <SoCSOIncludes.h>
#include <CSOBase/CSODefines.h>
#include <SoView2D.h>

Go to the source code of this file.

Classes
struct	CSOEvalEventView2DInfos
struct	CSOEvalEventCSOInfos
struct	CSODrawView2DInfos
struct	CSOSliceCrossing
struct	CSOVoxelSlab
	Defines the z slab of a CSO bounding box in voxel coordinates. More...
struct	CSODrawSliceInformation
struct	CSODrawCSOInfos
struct	CSOLabelRenderInformation
	Structure to store render information for a certain CSO and viewer. More...
struct	CSOVisualParameters
	Structure to hold visual parameters for the old editor. More...
struct	CSOEditorState
	Structure holding information about the processor/editor state. More...

Namespaces
	ml
	Main documentation file for ML users and developers.

Macros
#define	TAG_VIEWER_ID   "viewerId"

Typedefs
typedef CSOEvalEventView2DInfos	CSOProcessView2DInfos
	Typedefs for backward compatibility. More...
typedef CSOEvalEventCSOInfos	CSOProcessCSOInfos

Enumerations
enum	CSOSliceInformation {   CSO_SLICE_UNKNOWN = 0 , CSO_SLICE_COMPLETELY_ON , CSO_SLICE_CROSSED , CSO_SLICE_COMPLETELY_ABOVE ,   CSO_SLICE_COMPLETELY_BELOW }
enum	SEED_POINT_MARKER_MODES { SHOW_MARKER_NONE = 0 , SHOW_MARKER_RECT = 1 , SHOW_MARKER_CIRCLE = 2 }
	Enumeration of markers for seed points. More...
enum	COLOR_MODES { COLOR_AS_CSO = 0 , COLOR_GENERAL = 1 }
	Enumeration of marker coloring. More...
enum	STYLE_PALETTE_INDEX_USE { USE_INDEX_FOR_CSO = 0 , USE_INDEX_FOR_GROUP = 1 }
	Enumeration of the usage of style palette indices. More...
enum	HIT_POINT_MODE { HIT_NOTHING_HIT = 0 , HIT_SEED_POINT = 1 , HIT_PATH_POINT = 2 }
	Enumeration for different hit point modes. More...
enum	SELECTION_COLOR_MODES { SELECTION_COLOR_MODE_BRIGHTEN = 0 , SELECTION_COLOR_MODE_FIXED = 1 }
	Defines the color mode for selected CSOs. More...
enum	SELECTION_LINE_WIDTH_MODES { SELECTION_LINE_WIDEN = 0 , SELECTION_LINE_FIXED = 1 }
	Defines the line width mode for selected CSOs. More...
enum	SELECTED_SEED_POINT_COLOR_MODES { SELECTED_SEED_POINT_COLOR_MODE_BRIGHTEN = 0 , SELECTED_SEED_POINT_COLOR_MODE_FIXED = 1 }
	Defines the color mode for selected seed points. More...
enum	SELECTED_SEED_POINT_SIZE_MODES { SELECTED_SEED_POINT_ENLARGE = 0 , SELECTED_SEED_POINT_FIXED = 1 }
	Defines the size mode for selected seed points. More...
enum	HIGHLIGHT_COLOR_MODES { HIGHLIGHT_COLOR_MODE_BRIGHTEN = 0 , HIGHLIGHT_COLOR_MODE_FIXED = 1 }
	Defines the highlighting color mode for CSOs under the mouse cursor. More...
enum	HIGHLIGHT_LINE_WIDTH_MODES { HIGHLIGHT_LINE_WIDEN = 0 , HIGHLIGHT_LINE_FIXED = 1 }
	Defines the highlighting line width mode for CSOs under the mouse cursor. More...
enum	SIDE_FILLING_LINE_WIDTH_MODES { SIDE_FILLING_WIDTH_AS_CSO = 0 , SIDE_FILLING_WIDTH_AUTOMATIC , SIDE_FILLING_WIDTH_MANUAL }
	Enumeration of line width modes for side fillings. More...

Variables
const unsigned short	PATH_POINTS_PATTERN_NONE = 0x0000
	Line pattern for no line at all. More...
const unsigned short	PATH_POINTS_PATTERN_SOLID = 0xFFFF
const unsigned short	PATH_POINTS_PATTERN_DASHED = 0xF0F0
	Line pattern for a dashed line. More...
const unsigned short	PATH_POINTS_PATTERN_DOTTED = 0xAAAA
	Line pattern for a dotted line. More...
const unsigned short	PATH_POINTS_PATTERN_SHORT_DASHED = 0xC7C7

Macro Definition Documentation

TAG_VIEWER_ID

#define TAG_VIEWER_ID   "viewerId"

Definition at line 316 of file SoCSODefines.h.

Typedef Documentation

CSOProcessCSOInfos

typedef CSOEvalEventCSOInfos CSOProcessCSOInfos

Definition at line 61 of file SoCSODefines.h.

CSOProcessView2DInfos

typedef CSOEvalEventView2DInfos CSOProcessView2DInfos

Typedefs for backward compatibility.

Definition at line 60 of file SoCSODefines.h.

Enumeration Type Documentation

COLOR_MODES

enum COLOR_MODES

Enumeration of marker coloring.

Enumerator
COLOR_AS_CSO	The marker is shown in the same color as the CSO.
COLOR_GENERAL	Use the general marker color for all markers.

Definition at line 181 of file SoCSODefines.h.

CSOSliceInformation

enum CSOSliceInformation

Enumerator
CSO_SLICE_UNKNOWN	No information about the CSO and the current slice.
CSO_SLICE_COMPLETELY_ON	The CSO lies completely on the current slice.
CSO_SLICE_CROSSED	The CSO is crossed by the current slice.
CSO_SLICE_COMPLETELY_ABOVE	The CSO lies completely above the current slice.
CSO_SLICE_COMPLETELY_BELOW	The CSO lies completely below the current slice.

Definition at line 92 of file SoCSODefines.h.

HIGHLIGHT_COLOR_MODES

enum HIGHLIGHT_COLOR_MODES

Defines the highlighting color mode for CSOs under the mouse cursor.

Enumerator
HIGHLIGHT_COLOR_MODE_BRIGHTEN	Highlight color mode: the CSO under the mouse cursor is brightened.
HIGHLIGHT_COLOR_MODE_FIXED	Highlight color mode: the CSO under the mouse cursor is set to a fixed color.

Definition at line 281 of file SoCSODefines.h.

HIGHLIGHT_LINE_WIDTH_MODES

enum HIGHLIGHT_LINE_WIDTH_MODES

Defines the highlighting line width mode for CSOs under the mouse cursor.

Enumerator
HIGHLIGHT_LINE_WIDEN	Highlight line width mode: the line width of the CSOs under the mouse cursor is widened.
HIGHLIGHT_LINE_FIXED	Highlight line width mode: the line width of the CSOs under the mouse cursor is set to a certain value.

Definition at line 290 of file SoCSODefines.h.

HIT_POINT_MODE

enum HIT_POINT_MODE

Enumeration for different hit point modes.

Enumerator
HIT_NOTHING_HIT	Hit point was nowhere near an existing CSO.
HIT_SEED_POINT	Hit point was near an existing seed point.
HIT_PATH_POINT	Hit point was near a path point.

Definition at line 235 of file SoCSODefines.h.

SEED_POINT_MARKER_MODES

enum SEED_POINT_MARKER_MODES

Enumeration of markers for seed points.

Enumerator
SHOW_MARKER_NONE	Shows no marker at the seed point positions.
SHOW_MARKER_RECT	Shows a rectangle at the seed point positions.
SHOW_MARKER_CIRCLE	Shows a circle at the seed point positions.

Definition at line 171 of file SoCSODefines.h.

SELECTED_SEED_POINT_COLOR_MODES

enum SELECTED_SEED_POINT_COLOR_MODES

Defines the color mode for selected seed points.

Enumerator
SELECTED_SEED_POINT_COLOR_MODE_BRIGHTEN	Selected seed point color mode: the selected seed point is brightened.
SELECTED_SEED_POINT_COLOR_MODE_FIXED	Selected seed point color mode: the selected seed point is set to a fixed color.

Definition at line 263 of file SoCSODefines.h.

SELECTED_SEED_POINT_SIZE_MODES

enum SELECTED_SEED_POINT_SIZE_MODES

Defines the size mode for selected seed points.

Enumerator
SELECTED_SEED_POINT_ENLARGE	Selected seed point size mode: the size of the selected seed point is enlarged.
SELECTED_SEED_POINT_FIXED	Selected seed point size mode: the size of the selected seed point is set to a fixed value.

Definition at line 272 of file SoCSODefines.h.

SELECTION_COLOR_MODES

enum SELECTION_COLOR_MODES

Defines the color mode for selected CSOs.

Enumerator
SELECTION_COLOR_MODE_BRIGHTEN	Selection color mode: the selected CSO is brightened.
SELECTION_COLOR_MODE_FIXED	Selection color mode: the selected CSO is set to a fixed color.

Definition at line 245 of file SoCSODefines.h.

SELECTION_LINE_WIDTH_MODES

enum SELECTION_LINE_WIDTH_MODES

Defines the line width mode for selected CSOs.

Enumerator
SELECTION_LINE_WIDEN	Selection line width mode: the line width of the selected CSO is widened.
SELECTION_LINE_FIXED	Selection line width mode: the line width of the selected CSO is set to a certain value.

Definition at line 254 of file SoCSODefines.h.

SIDE_FILLING_LINE_WIDTH_MODES

enum SIDE_FILLING_LINE_WIDTH_MODES

Enumeration of line width modes for side fillings.

Enumerator
SIDE_FILLING_WIDTH_AS_CSO
SIDE_FILLING_WIDTH_AUTOMATIC
SIDE_FILLING_WIDTH_MANUAL

Definition at line 299 of file SoCSODefines.h.

STYLE_PALETTE_INDEX_USE

enum STYLE_PALETTE_INDEX_USE

Enumeration of the usage of style palette indices.

Enumerator
USE_INDEX_FOR_CSO	The style of the according CSO index is chosen.
USE_INDEX_FOR_GROUP	The style of the according Group index is chosen (overrides CSO style).

Definition at line 190 of file SoCSODefines.h.

Variable Documentation

PATH_POINTS_PATTERN_DASHED

const unsigned short PATH_POINTS_PATTERN_DASHED = 0xF0F0

Line pattern for a dashed line.

Definition at line 310 of file SoCSODefines.h.

Referenced by ml::CSOVisualizationSettings::stipplePattern().

PATH_POINTS_PATTERN_DOTTED

const unsigned short PATH_POINTS_PATTERN_DOTTED = 0xAAAA

Line pattern for a dotted line.

Definition at line 311 of file SoCSODefines.h.

Referenced by ml::CSOVisualizationSettings::stipplePattern().

PATH_POINTS_PATTERN_NONE

const unsigned short PATH_POINTS_PATTERN_NONE = 0x0000

Line pattern for no line at all.

Definition at line 308 of file SoCSODefines.h.

Referenced by ml::CSOVisualizationSettings::stipplePattern().

PATH_POINTS_PATTERN_SHORT_DASHED

const unsigned short PATH_POINTS_PATTERN_SHORT_DASHED = 0xC7C7

Definition at line 312 of file SoCSODefines.h.

Referenced by ml::CSOVisualizationSettings::stipplePattern().

PATH_POINTS_PATTERN_SOLID

const unsigned short PATH_POINTS_PATTERN_SOLID = 0xFFFF

Definition at line 309 of file SoCSODefines.h.

Referenced by ml::CSOVisualizationSettings::stipplePattern().