CSODefines.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
 
 
#pragma once
 
 
ML_START_NAMESPACE
 
 
enum CSOVoxelWriteModes
{
  VOXEL_WRITE_ID            = 0, 
  VOXEL_WRITE_CONST         = 1, 
  VOXEL_WRITE_CONST_PLUS_ID = 2, 
  VOXEL_WRITE_MODULE        = 3, 
  VOXEL_VALUE_ID = VOXEL_WRITE_ID,
  VOXEL_VALUE_CONST = VOXEL_WRITE_CONST,
  VOXEL_VALUE_CONST_PLUS_ID = VOXEL_WRITE_CONST_PLUS_ID,
  VOXEL_VALUE_MODULE = VOXEL_WRITE_MODULE
};
 
 
enum CSOPathPointsStyle
{
  PATH_POINTS_STYLE_NONE   = 0,      
  PATH_POINTS_STYLE_SOLID  = 1,      
  PATH_POINTS_STYLE_DASHED = 2,      
  PATH_POINTS_STYLE_DOTTED = 3,      
  PATH_POINTS_STYLE_SHORT_DASHED = 4 
};
 
enum CSOLineStyle
{
  LINE_STYLE_NONE   = PATH_POINTS_STYLE_NONE,
  LINE_STYLE_SOLID  = PATH_POINTS_STYLE_SOLID,
  LINE_STYLE_DASHED = PATH_POINTS_STYLE_DASHED,
  LINE_STYLE_DOTTED = PATH_POINTS_STYLE_DOTTED,
  LINE_STYLE_SHORT_DASHED = PATH_POINTS_STYLE_SHORT_DASHED
};
 
 
enum CSOSelectionColoring
{
  SELECTION_COLORING_BRIGHTEN = 0, 
  SELECTION_COLORING_FIXED    = 1  
};
 
 
enum CSOSelectionLineWidth
{
  SELECTION_LINE_WIDTH_WIDEN = 0, 
  SELECTION_LINE_WIDTH_FIXED = 1  
};
 
 
enum CSOSelectedSeedPointColoring
{
  SELECTED_SEED_POINT_COLORING_BRIGHTEN = 0, 
  SELECTED_SEED_POINT_COLORING_FIXED    = 1  
};
 
 
enum CSOSelectedSeedPointSize
{
  SELECTED_SEED_POINT_SIZE_ENLARGE = 0, 
  SELECTED_SEED_POINT_SIZE_FIXED   = 1  
};
 
 
enum CSOSeedPointStyle
{
  SEED_POINT_STYLE_NONE              = 0,
  SEED_POINT_STYLE_RECTANGLE         = 1,
  SEED_POINT_STYLE_CIRCLE            = 2,
  SEED_POINT_STYLE_FIXED_SIZE_CIRCLE = 3,
  SEED_POINT_STYLE_TRIANGLE          = 4,
  SEED_POINT_STYLE_FILLED_RECTANGLE  = 5,
  SEED_POINT_STYLE_FILLED_CIRCLE     = 6,
  SEED_POINT_STYLE_FILLED_TRIANGLE   = 7,
  SEED_POINT_STYLE_DASHED_RECTANGLE  = 8
};
 
enum CSOMarkerDisplayMode
{
  MARKER_DISPLAY_MODE_NONE   = SEED_POINT_STYLE_NONE,
  MARKER_DISPLAY_MODE_RECT   = SEED_POINT_STYLE_RECTANGLE,
  MARKER_DISPLAY_MODE_CIRCLE = SEED_POINT_STYLE_CIRCLE,
  MARKER_DISPLAY_MODE_TRIANGLE = SEED_POINT_STYLE_TRIANGLE
};
 
 
enum CSOErrorCode
{
  CSO_RESULT_OK           = 0, 
  CSO_NO_INPUT_IMAGE      = 1, 
  CSO_INVALID_INPUT_IMAGE = 2, 
  CSO_NO_MEMORY           = 3  
};
 
 
enum CSOUpdateModes
{
  MODE_OFF          = 0, 
  MODE_AUTO_UPDATE  = 1, 
  MODE_AUTO_CLEAR   = 2  
};
 
 
enum CSOProcessorMode
{
  PROCESSOR_MODE_MODIFICATOR           = 0, 
  PROCESSOR_MODE_GENERATOR             = 1, 
  PROCESSOR_MODE_GENERATOR_MODIFICATOR = 2  
};
 
 
enum CSOProcessorPickingMode
{
  PROCESSOR_PICKING_MODE_SEED_POINTS = 0, 
  PROCESSOR_PICKING_MODE_PATH_POINTS = 1  
};
 
 
enum CSOSmoothingModes
{
  SMOOTHING_MODE_NONE                 = 0, 
  SMOOTHING_MODE_SPLINE_APPROXIMATION = 1, 
  SMOOTHING_MODE_SPLINE_INTERPOLATION = 2  
};
 
 
enum Corner
{
  TLR = 0, 
  TRR = 1, 
  TRF = 2, 
  TLF = 3, 
  BLR = 4, 
  BRR = 5, 
  BRF = 6, 
  BLF = 7  
};
 
 
enum Direction
{
  DIRECTION_TOP    = 0,
  DIRECTION_BOTTOM = 1,
  DIRECTION_RIGHT  = 2,
  DIRECTION_LEFT   = 3,
  DIRECTION_FRONT  = 4,
  DIRECTION_REAR   = 5,
  DIRECTION_NUM_DIRECTIONS = 6
};
 
 
enum CrossingSide
{
  CrossingTop    = 0, 
  CrossingBottom = 1, 
  CrossingRight  = 2, 
  CrossingLeft   = 3, 
  CrossingFront  = 4, 
  CrossingRear   = 5, 
  CrossingNone   = 6  
};
 
 
// Common
const std::string nameCommonNumCSOs   = "NumCSOs";                    
const std::string nameCommonNumGroups = "NumGroups";                  
 
const std::string nameCommonNumSelectedCSOs   = "NumSelectedCSOs";    
const std::string nameCommonNumSelectedGroups = "NumSelectedGroups";  
 
// Attributes
const std::string nameAttribId             = "Id";                    
const std::string nameAttribLabel          = "Label";                 
const std::string nameAttribDescription    = "Description";           
 
const std::string nameAttribTimePointIndex = "TimePointIndex";        
const std::string nameAttribShowState      = "ShowState";             
const std::string nameAttribVoxelizeState  = "VoxelizeState";         
const std::string nameAttribEditableState  = "EditableState";         
 
const std::string nameAttribPathPointStyle = "PathPointStyle";        
const std::string nameAttribPathPointWidth = "PathPointWidth";        
const std::string nameAttribPathPointColor = "PathPointColor";        
const std::string nameAttribPathPointAlpha = "PathPointAlpha";        
 
const std::string nameAttribSeedPointStyle = "SeedPointStyle";        
const std::string nameAttribSeedPointSize  = "SeedPointSize";         
const std::string nameAttribSeedPointColor = "SeedPointColor";        
const std::string nameAttribSeedPointAlpha = "SeedPointAlpha";        
 
const std::string nameAttribVoxelWriteMode = "VoxelWriteMode";        
const std::string nameAttribVoxelWriteValue= "VoxelWriteValue";       
 
const std::string nameAttribNumUserData    = "NumUserData";           //<! String name for the number of user data.
const std::string nameAttribUserDataName   = "UserDataName";          //<! String name for the name of a user data entry.
const std::string nameAttribUserDataType   = "UserDataType";          //<! String name for the type of a user data entry.
const std::string nameAttribUserDataValue  = "UserDataValue";         //<! String name for the value of a user data entry.
 
// Kept just because of backward compatibility of old CSO files
const std::string nameAttribLineStyle      = "LineStyle";             
const std::string nameAttribColor          = "Color";                 
const std::string nameAttribAlpha          = "Alpha";                 
const std::string nameAttribLineWidth      = "LineWidth";             
 
const std::string nameAttribMarkerMode     = "MarkerMode";            
const std::string nameAttribMarkerColor    = "MarkerColor";           
const std::string nameAttribMarkerAlpha    = "MarkerAlpha";           
const std::string nameAttribMarkerSize     = "MarkerSize";            
 
const std::string nameAttribVoxelValue     = "VoxelValue";            
 
// CSO
const std::string nameCSONumSeedPoints     = "NumSeedPoints";         
const std::string nameCSONumPathPointLists = "NumPathPointLists";     
const std::string namePathNumPoints        = "PathNumPoints";         
const std::string nameCSOFinished          = "IsFinished";            
const std::string nameCSOClosed            = "IsClosed";              
const std::string nameCSOInPlane           = "IsInPlane";             
const std::string nameCSOPlaneNormal       = "PlaneNormal";           
const std::string nameCSOBoundingBox       = "BoundingBox";           
const std::string nameCSOType              = "Type";                  
const std::string nameCSOSubType           = "SubType";               
const std::string nameCSOCreatorId         = "CreatorId";             
 
// CSOGroup
const std::string nameGroupMaximumCSOs            = "MaximumCSOs";
const std::string nameGroupOverflowHandling       = "OverflowHandling";
const std::string nameGroupRemoveCSOHandling      = "RemoveCSOHandling";
const std::string nameGroupDeleteGroupCSOHandling = "DeleteGroupCSOHandling";
 
const std::string nameGroupUseTimePointIndex = "UseTimePointIndex";   
const std::string nameGroupUseShowState      = "UseShowState";        
const std::string nameGroupUseVoxelizeState  = "UseVoxelizeState";    
const std::string nameGroupUseEditableState  = "UseEditableState";    
 
const std::string nameGroupUsePathPointStyle = "UsePathPointStyle";   
const std::string nameGroupUsePathPointWidth = "UsePathPointWidth";   
const std::string nameGroupUsePathPointColor = "UsePathPointColor";   
const std::string nameGroupUsePathPointAlpha = "UsePathPointAlpha";   
 
const std::string nameGroupUseSeedPointStyle = "UseSeedPointStyle";   
const std::string nameGroupUseSeedPointSize  = "UseSeedPointSize";    
const std::string nameGroupUseSeedPointColor = "UseSeedPointColor";   
const std::string nameGroupUseSeedPointAlpha = "UseSeedPointAlpha";   
 
const std::string nameGroupUseVoxelWriteMode  = "UseVoxelWriteMode";  
const std::string nameGroupUseVoxelWriteValue = "UseVoxelWriteValue"; 
 
// Kept just because of backward compatibility of old CSO files
const std::string nameGroupUseVisuals        = "UseVisuals";          
const std::string nameGroupUseMarkerSettings = "UseMarkerSettings";   
 
 
typedef Tvec3<MLint> VoxelPosition;
 
 
ML_END_NAMESPACE