DefaultOptions.h File Reference

#include "GmshConfig.h"
#include "GmshDefines.h"
#include "Options.h"

Include dependency graph for DefaultOptions.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	S   GMSH_SESSIONRC
#define	O   GMSH_OPTIONSRC
#define	F   GMSH_FULLRC
#define	D   GMSH_DEPRECATED
#define	COLW   {210, 210, 210, 255}
#define	COLT   {160, 150, 255, 255}
#define	COLQ   {130, 120, 225, 255}
#define	COLP   {232, 210, 23, 255}
#define	COLY   {217, 113, 38, 255}
#define	COLR   {20, 255, 0, 255}
#define	COL0   {255, 120, 0, 255}
#define	COL2   {255, 160, 0, 255}
#define	COL4   {255, 200, 0, 255}
#define	COL6   {255, 240, 0, 255}
#define	COL8   {228, 255, 0, 255}
#define	COL10   {188, 255, 0, 255}
#define	COL12   {148, 255, 0, 255}
#define	COL14   {108, 255, 0, 255}
#define	COL16   {68, 255, 0, 255}
#define	COL18   {0, 255, 52, 255}
#define	COL1   {0, 255, 132, 255}
#define	COL3   {0, 255, 192, 255}
#define	COL5   {0, 216, 255, 255}
#define	COL7   {0, 176, 255, 255}
#define	COL9   {0, 116, 255, 255}
#define	COL11   {0, 76, 255, 255}
#define	COL13   {24, 0, 255, 255}
#define	COL15   {84, 0, 255, 255}
#define	COL17   {104, 0, 255, 255}
#define	COL19   {184, 0, 255, 255}
#define	ELECOL   {0, 0, 0, 255}, {0, 0, 0, 255}, {0, 0, 0, 255}, {245, 245, 245, 255}

Variables
StringXString	GeneralOptions_String []
StringXString	GeometryOptions_String []
StringXString	MeshOptions_String []
StringXString	SolverOptions_String []
StringXString	PostProcessingOptions_String []
StringXString	ViewOptions_String []
StringXString	PrintOptions_String []
StringXNumber	GeneralOptions_Number []
StringXNumber	GeometryOptions_Number []
StringXNumber	MeshOptions_Number []
StringXNumber	SolverOptions_Number []
StringXNumber	PostProcessingOptions_Number []
StringXNumber	ViewOptions_Number []
StringXNumber	PrintOptions_Number []
StringXColor	GeneralOptions_Color []
StringXColor	GeometryOptions_Color []
StringXColor	MeshOptions_Color []
StringXColor	SolverOptions_Color []
StringXColor	PostProcessingOptions_Color []
StringXColor	ViewOptions_Color []
StringXColor	PrintOptions_Color []

Macro Definition Documentation

COL0

#define COL0   {255, 120, 0, 255}

Definition at line 2201 of file DefaultOptions.h.

COL1

#define COL1   {0, 255, 132, 255}

Definition at line 2211 of file DefaultOptions.h.

COL10

#define COL10   {188, 255, 0, 255}

Definition at line 2206 of file DefaultOptions.h.

COL11

#define COL11   {0, 76, 255, 255}

Definition at line 2216 of file DefaultOptions.h.

COL12

#define COL12   {148, 255, 0, 255}

Definition at line 2207 of file DefaultOptions.h.

COL13

#define COL13   {24, 0, 255, 255}

Definition at line 2217 of file DefaultOptions.h.

COL14

#define COL14   {108, 255, 0, 255}

Definition at line 2208 of file DefaultOptions.h.

COL15

#define COL15   {84, 0, 255, 255}

Definition at line 2218 of file DefaultOptions.h.

COL16

#define COL16   {68, 255, 0, 255}

Definition at line 2209 of file DefaultOptions.h.

COL17

#define COL17   {104, 0, 255, 255}

Definition at line 2219 of file DefaultOptions.h.

COL18

#define COL18   {0, 255, 52, 255}

Definition at line 2210 of file DefaultOptions.h.

COL19

#define COL19   {184, 0, 255, 255}

Definition at line 2220 of file DefaultOptions.h.

COL2

#define COL2   {255, 160, 0, 255}

Definition at line 2202 of file DefaultOptions.h.

COL3

#define COL3   {0, 255, 192, 255}

Definition at line 2212 of file DefaultOptions.h.

COL4

#define COL4   {255, 200, 0, 255}

Definition at line 2203 of file DefaultOptions.h.

COL5

#define COL5   {0, 216, 255, 255}

Definition at line 2213 of file DefaultOptions.h.

COL6

#define COL6   {255, 240, 0, 255}

Definition at line 2204 of file DefaultOptions.h.

COL7

#define COL7   {0, 176, 255, 255}

Definition at line 2214 of file DefaultOptions.h.

COL8

#define COL8   {228, 255, 0, 255}

Definition at line 2205 of file DefaultOptions.h.

COL9

#define COL9   {0, 116, 255, 255}

Definition at line 2215 of file DefaultOptions.h.

COLP

#define COLP   {232, 210, 23, 255}

Definition at line 2197 of file DefaultOptions.h.

COLQ

#define COLQ   {130, 120, 225, 255}

Definition at line 2196 of file DefaultOptions.h.

COLR

#define COLR   {20, 255, 0, 255}

Definition at line 2199 of file DefaultOptions.h.

COLT

#define COLT   {160, 150, 255, 255}

Definition at line 2195 of file DefaultOptions.h.

COLW

#define COLW   {210, 210, 210, 255}

Definition at line 2194 of file DefaultOptions.h.

COLY

#define COLY   {217, 113, 38, 255}

Definition at line 2198 of file DefaultOptions.h.

D

#define D   GMSH_DEPRECATED

Definition at line 25 of file DefaultOptions.h.

ELECOL

#define ELECOL   {0, 0, 0, 255}, {0, 0, 0, 255}, {0, 0, 0, 255}, {245, 245, 245, 255}

Definition at line 2316 of file DefaultOptions.h.

F

#define F   GMSH_FULLRC

Definition at line 24 of file DefaultOptions.h.

O

#define O   GMSH_OPTIONSRC

Definition at line 23 of file DefaultOptions.h.

S

#define S   GMSH_SESSIONRC

Definition at line 22 of file DefaultOptions.h.

Variable Documentation

GeneralOptions_Color

StringXColor GeneralOptions_Color[]

Initial value:

= {
  { F|O, "Background" , opt_general_color_background ,
    {255, 255, 255, 255}, {255, 255, 255, 255}, {245, 245, 245, 255}, {0, 0, 0, 255},
    "Background color" },
  { F|O, "BackgroundGradient" , opt_general_color_background_gradient ,
    {255, 255, 255, 255}, {208, 215, 255, 255}, {185, 185, 185, 255}, {0, 0, 0, 255},
    "Background gradient color" },
  { F|O, "Foreground" , opt_general_color_foreground ,
    {85, 85, 85, 255}, {85, 85, 85, 255}, {85, 85, 85, 255}, {170, 170, 170, 255},
    "Foreground color" },
  { F|O, "Text" , opt_general_color_text ,
    {0, 0, 0, 255}, {0, 0, 0, 255}, {0, 0, 0, 255}, {245, 245, 245, 255},
    "Text color" },
  { F|O, "Axes" , opt_general_color_axes ,
    {0, 0, 0, 255}, {0, 0, 0, 255}, {0, 0, 0, 255}, {245, 245, 245, 255},
    "Axes color" },
  { F|O, "SmallAxes" , opt_general_color_small_axes ,
    {0, 0, 0, 255}, {0, 0, 0, 255}, {0, 0, 0, 255}, {245, 245, 245, 255},
    "Small axes color" },
  { F|O, "AmbientLight" , opt_general_color_ambient_light,
    {25, 25, 25, 255}, {25, 25, 25, 255}, {25, 25, 25, 255}, {25, 25, 25, 255},
    "Ambient light color" },
  { F|O, "DiffuseLight" , opt_general_color_diffuse_light,
    {255, 255, 255, 255}, {255, 255, 255, 255}, {255, 255, 255, 255}, {255, 255, 255, 255},
    "Diffuse light color" },
  { F|O, "SpecularLight" , opt_general_color_specular_light,
    {255, 255, 255, 255}, {255, 255, 255, 255}, {255, 255, 255, 255}, {255, 255, 255, 255},
    "Specular light color" },
  { 0, nullptr , nullptr ,  {0, 0, 0, 0}, {0, 0, 0, 0}, {0, 0, 0, 0} , {0, 0, 0, 0} , nullptr }
}

Definition at line 2122 of file DefaultOptions.h.

Referenced by ColorOption(), InitOptions(), InitOptionsGUI(), opt_general_color_scheme(), PrintOptions(), and PrintOptionsDoc().

GeneralOptions_Number

StringXNumber GeneralOptions_Number[]

Definition at line 364 of file DefaultOptions.h.

Referenced by InitOptions(), InitOptionsGUI(), NumberOption(), PrintOptions(), and PrintOptionsDoc().

GeneralOptions_String

StringXString GeneralOptions_String[]

Definition at line 28 of file DefaultOptions.h.

Referenced by InitOptions(), InitOptionsGUI(), PrintOptions(), PrintOptionsDoc(), and StringOption().

GeometryOptions_Color

StringXColor GeometryOptions_Color[]

Definition at line 2153 of file DefaultOptions.h.

Referenced by ColorOption(), InitOptions(), InitOptionsGUI(), opt_general_color_scheme(), PrintOptions(), and PrintOptionsDoc().

GeometryOptions_Number

StringXNumber GeometryOptions_Number[]

Definition at line 860 of file DefaultOptions.h.

Referenced by InitOptions(), InitOptionsGUI(), NumberOption(), PrintOptions(), and PrintOptionsDoc().

GeometryOptions_String

StringXString GeometryOptions_String[]

Initial value:

= {
  { F|O, "DoubleClickedPointCommand" , opt_geometry_double_clicked_point_command,
    "ONELAB" , "Command parsed when double-clicking on a point, or 'ONELAB' "
    "to edit associated ONELAB parameters" },
  { F|O, "DoubleClickedCurveCommand" , opt_geometry_double_clicked_curve_command,
    "ONELAB" , "Command parsed when double-clicking on a curve, or 'ONELAB' "
    "to edit associated ONELAB parameters" },
  { F|O|D, "DoubleClickedLineCommand" , opt_geometry_double_clicked_curve_command,
    "ONELAB" , "[Deprecated]" },
  { F|O, "DoubleClickedSurfaceCommand" , opt_geometry_double_clicked_surface_command,
    "ONELAB" , "Command parsed when double-clicking on a surface, or 'ONELAB' "
    "to edit associated ONELAB parameters" },
  { F|O, "DoubleClickedVolumeCommand" , opt_geometry_double_clicked_volume_command,
    "ONELAB" , "Command parsed when double-clicking on a volume, or 'ONELAB' "
    "to edit associated ONELAB parameters" },
 
  { F|O, "OCCTargetUnit" , opt_geometry_occ_target_unit , "" ,
    "Length unit to which coordinates from STEP and IGES files are converted to when "
    "imported by OpenCASCADE, e.g. 'M' for meters (leave empty to use the default "
    "OpenCASCADE behavior); the option should be set before importing the STEP or "
    "IGES file"},
 
  { F|O, "PipeDefaultTrihedron" , opt_geometry_pipe_default_trihedron,
    "DiscreteTrihedron" , "Default trihedron type when creating pipes" },
 
  { 0, nullptr , nullptr , "" , nullptr }
}

Definition at line 142 of file DefaultOptions.h.

Referenced by InitOptions(), InitOptionsGUI(), PrintOptions(), PrintOptionsDoc(), and StringOption().

MeshOptions_Color

StringXColor MeshOptions_Color[]

Definition at line 2221 of file DefaultOptions.h.

Referenced by ColorOption(), InitOptions(), InitOptionsGUI(), opt_general_color_scheme(), PrintOptions(), and PrintOptionsDoc().

MeshOptions_Number

StringXNumber MeshOptions_Number[]

Definition at line 1067 of file DefaultOptions.h.

Referenced by InitOptions(), InitOptionsGUI(), NumberOption(), PrintOptions(), and PrintOptionsDoc().

MeshOptions_String

StringXString MeshOptions_String[]

Initial value:

= {
  { 0, nullptr , nullptr , "" , nullptr }
}

Definition at line 170 of file DefaultOptions.h.

Referenced by InitOptions(), InitOptionsGUI(), PrintOptions(), PrintOptionsDoc(), and StringOption().

PostProcessingOptions_Color

StringXColor PostProcessingOptions_Color[]

Initial value:

= {
  { 0, nullptr , nullptr , {0, 0, 0, 0}, {0, 0, 0, 0}, {0, 0, 0, 0}, {0, 0, 0, 0} , nullptr }
}

Definition at line 2311 of file DefaultOptions.h.

Referenced by ColorOption(), InitOptions(), InitOptionsGUI(), opt_general_color_scheme(), PrintOptions(), and PrintOptionsDoc().

PostProcessingOptions_Number

StringXNumber PostProcessingOptions_Number[]

Definition at line 1637 of file DefaultOptions.h.

Referenced by InitOptions(), InitOptionsGUI(), NumberOption(), PrintOptions(), and PrintOptionsDoc().

PostProcessingOptions_String

StringXString PostProcessingOptions_String[]

Initial value:

= {
  { F|O, "DoubleClickedGraphPointCommand" , opt_post_double_clicked_graph_point_command, "" ,
    "Command parsed when double-clicking on a graph data point "
    "(e.g. Merge Sprintf('file_%g.pos', PostProcessing.GraphPointX);)" },
 
  { F|O, "GraphPointCommand" , opt_post_double_clicked_graph_point_command, "" ,
    "Synonym for `DoubleClickedGraphPointCommand'" },
 
  { 0, nullptr , nullptr , "" , nullptr }
}

Definition at line 278 of file DefaultOptions.h.

Referenced by InitOptions(), InitOptionsGUI(), PrintOptions(), PrintOptionsDoc(), and StringOption().

PrintOptions_Color

StringXColor PrintOptions_Color[]

Initial value:

= {
  { 0, nullptr , nullptr , {0, 0, 0, 0}, {0, 0, 0, 0}, {0, 0, 0, 0}, {0, 0, 0, 0} , nullptr }
}

Definition at line 2342 of file DefaultOptions.h.

Referenced by ColorOption(), InitOptions(), InitOptionsGUI(), opt_general_color_scheme(), PrintOptions(), and PrintOptionsDoc().

PrintOptions_Number

StringXNumber PrintOptions_Number[]

Definition at line 1989 of file DefaultOptions.h.

Referenced by InitOptions(), InitOptionsGUI(), NumberOption(), PrintOptions(), and PrintOptionsDoc().

PrintOptions_String

StringXString PrintOptions_String[]

Initial value:

= {
  { F|O, "ParameterCommand" , opt_print_parameter_command ,
    "Mesh.Clip=1; View.Clip=1; General.ClipWholeElements=1; "
    "General.Clip0D=Print.Parameter; SetChanged;" ,
    "Command parsed when the print parameter is changed" },
 
  { 0, nullptr , nullptr , "" , nullptr }
}

Definition at line 353 of file DefaultOptions.h.

Referenced by InitOptions(), InitOptionsGUI(), PrintOptions(), PrintOptionsDoc(), and StringOption().

SolverOptions_Color

StringXColor SolverOptions_Color[]

Initial value:

= {
  { 0, nullptr , nullptr , {0, 0, 0, 0}, {0, 0, 0, 0}, {0, 0, 0, 0}, {0, 0, 0, 0} , nullptr }
}

Definition at line 2307 of file DefaultOptions.h.

Referenced by ColorOption(), InitOptions(), InitOptionsGUI(), opt_general_color_scheme(), PrintOptions(), and PrintOptionsDoc().

SolverOptions_Number

StringXNumber SolverOptions_Number[]

Definition at line 1602 of file DefaultOptions.h.

Referenced by InitOptions(), InitOptionsGUI(), NumberOption(), PrintOptions(), and PrintOptionsDoc().

SolverOptions_String

StringXString SolverOptions_String[]

Definition at line 174 of file DefaultOptions.h.

Referenced by InitOptions(), InitOptionsGUI(), PrintOptions(), PrintOptionsDoc(), and StringOption().

ViewOptions_Color

StringXColor ViewOptions_Color[]

Initial value:

= {
  { F|O, "Points" , opt_view_color_points , ELECOL, "Point color" },
  { F|O, "Lines" , opt_view_color_lines , ELECOL, "Line color" },
  { F|O, "Triangles" , opt_view_color_triangles , ELECOL, "Triangle color" },
  { F|O, "Quadrangles" , opt_view_color_quadrangles , ELECOL, "Quadrangle color" },
  { F|O, "Tetrahedra" , opt_view_color_tetrahedra , ELECOL, "Tetrahedron color" },
  { F|O, "Hexahedra" , opt_view_color_hexahedra , ELECOL, "Hexahedron color" },
  { F|O, "Prisms" , opt_view_color_prisms , ELECOL, "Prism color" },
  { F|O, "Pyramids" , opt_view_color_pyramids , ELECOL, "Pyramid color" },
  { F|O, "Trihedra" , opt_view_color_trihedra , ELECOL, "Trihedron color" },
  { F|O, "Tangents" , opt_view_color_tangents ,
    {255, 255, 0, 255}, {255, 255, 0, 255}, {0, 0, 0, 255}, {255, 255, 0, 255},
    "Tangent vector color" },
  { F|O, "Normals" , opt_view_color_normals ,
    {255, 0, 0, 255}, {255, 0, 0, 255}, {0, 0, 0, 255}, {255, 0, 0, 255},
    "Normal vector color" },
  { F|O, "Text2D" , opt_view_color_text2d , ELECOL, "2D text color" },
  { F|O, "Text3D" , opt_view_color_text3d , ELECOL, "3D text color" },
  { F|O, "Axes" , opt_view_color_axes , ELECOL, "Axes color" },
  { F|O, "Background2D" , opt_view_color_background2d ,
    {255, 255, 255, 200}, {255, 255, 255, 200}, {255, 255, 255, 200}, {245, 245, 245, 200},
    "Bacground color for 2D plots" },
  { 0, nullptr , nullptr , {0, 0, 0, 0}, {0, 0, 0, 0}, {0, 0, 0, 0}, {0, 0, 0, 0} , nullptr }
}

Definition at line 2317 of file DefaultOptions.h.

Referenced by ColorOption(), InitOptions(), opt_general_color_scheme(), PrintOptions(), and PrintOptionsDoc().

ViewOptions_Number

StringXNumber ViewOptions_Number[]

Definition at line 1697 of file DefaultOptions.h.

Referenced by InitOptions(), NumberOption(), PrintOptions(), and PrintOptionsDoc().

ViewOptions_String

StringXString ViewOptions_String[]

Definition at line 289 of file DefaultOptions.h.

Referenced by InitOptions(), PrintOptions(), PrintOptionsDoc(), and StringOption().