Enums

Details

class v_sim.AnimationType(value)

Bases: GLib.Enum

Various type of time evolution.

LINEAR = 0

a linear evolution.

QUAD = 1

a quadratic evolution.

SIN = 2

a sinusoid evolution.

class v_sim.ArrayErrorFlag(value)

Bases: GLib.Enum

Possible errors when reading a file with column data.

NO_COLUMN = 0

no column can be found in the file ;

MISSING_DATA = 1

some data are missing to match the required number of read data.

class v_sim.BoxBoundaries(value)

Bases: GLib.Enum

This describes the periodicity of the bounding box in the three directions.

FREE = 0

the system is isolated.

WIRE_X = 1

the periodicity is along X axis only ;

WIRE_Y = 2

the periodicity is along Y axis only ;

SURFACE_XY = 3

the Z axis is a free axis ;

WIRE_Z = 4

the periodicity is along Z axis only ;

SURFACE_ZX = 5

the Y axis is a free axis ;

SURFACE_YZ = 6

the X axis is a free axis ;

PERIODIC = 7

the full 3D periodicity ;

class v_sim.BoxHiddingStatus(value)

Bases: GLib.Enum

This describes the possibilty to use the box as a masking objects for nodes.

New in version 3.8.

NONE = 0

don’t apply masking.

OUTSIDE = 1

hide nodes outside the box.

INSIDE = 2

hide nodes inside the box.

class v_sim.BoxVector(value)

Bases: GLib.Enum

Identifier of every projection of the box super-cell on an orthogonal basis-set.

New in version 3.7.

DXX = 0

x box vector along X;

DYX = 1

y box vector along X;

DYY = 2

y box vector along Y;

DZX = 3

z box vector along X;

DZY = 4

z box vector along Y;

DZZ = 5

z box vector along Z;

N_VECTORS = 6

number of elements.

class v_sim.ButtonActionId(value)

Bases: GLib.Enum

Value that can be put into field buttonType of structure v_sim.SimplifiedEvents.

NONE = 0

not a button event

PRESS = 1

a press button event

RELEASE = 2

a release button event

class v_sim.ColorChannel(value)

Bases: GLib.Enum

Index to be used whenever accessing red, green or blue channels is required.

New in version 3.8.

RED = 0

the red channel.

GREEN = 1

the red channel.

BLUE = 2

the red channel.

ALPHA = 3

the red channel.

class v_sim.ColorizationInputScaleId(value)

Bases: GLib.Enum

Control how input data are converted into [0;1], after conversion, values are clamped if needed.

NORMALIZE = 0

input data are converted into [0;1] using input min/max values.

MINMAX = 1

input data are converted into [0;1] using user defined min/max values.

class v_sim.ConfigFileKind(value)

Bases: GLib.Enum

This defines a parameter entry in the config files.

PARAMETER = 0

a kind of configuration that is used to change settings in the way V_Sim is working.

RESOURCE = 1

a kind of configuartion that is used to change the rendering output of V_Sim.

class v_sim.DataColorizerFragmentTypes(value)

Bases: GLib.Enum

The fragment colorization schemes.

New in version 3.8.

NONE = 0

no per node colorization.

PER_FRAGMENT = 1

colorize each node of a given fragment with the same colour.

PER_TYPE = 2

colorize ecah node of the same fragment family with the same colour.

class v_sim.DataLoadableErrorFlag(value)

Bases: GLib.Enum

Thiese are flags used when reading a file with a v_sim.DataLoadable method.

METHOD = 0

Error from the v_sim.DataLoadable method.

FILE = 1

Error when opening.

FORMAT = 2

Wrongness in format.

UNKNOWN = 3

an error without specification.

CANCEL = 4

the v_sim.DataLoadable operation has been cancelled.

class v_sim.DumpErrorFlag(value)

Bases: GLib.Enum

These are flags used when dumping to a file.

OPENGL = 0

Error with OpenGL dumping.

FILE = 1

Error when opening.

ENCODE = 2

Wrongness when computing the encoding format.

class v_sim.ElementAtomicShapeId(value)

Bases: GLib.Enum

This enum is used as identifier for shapes managed by the attomic element method.

SPHERE = 0

draw sphere ;

CUBE = 1

draw cube ;

ELLIPSOID = 2

draw elipsoid ;

POINT = 3

draw square dot ;

TORUS = 4

draw torus ;

N_SHAPES = 5

number of shapes.

class v_sim.ElementRendererEffects(value)

Bases: GLib.Enum

The rendering done by v_sim.GlExtNodes can alter the color and material of rendered nodes.

New in version 3.7.

NO_EFFECT = 0

no effect (apply pristine element color and material).

INVERT = 1

invert colour.

FLATTEN_LIGHT = 10

render lighter without light efect.

HIGHLIGHT = 2

highlight colour (same material).

HIGHLIGHT_SEMI = 3

semi-transparent highlight colour with neutral material.

DESATURATE = 4

desaturate colour.

SATURATE = 5

saturate colour.

DARKEN = 6

darken colour.

LIGHTEN = 7

lighten colour.

FLATTEN_DARK = 8

render darker without light efect.

FLATTEN = 9

render without light efect.

class v_sim.ElementSpinShapeId(value)

Bases: GLib.Enum

An identifier for the different shapes to draw elements.

ARROW_SMOOTH = 0

the shape is smooth and rounded ;

ARROW_SHARP = 1

the shape is built on squares ;

ELLIPSOID = 2

the shape is an ellipsoid ;

TORUS = 3

the shape is a torus (direction of the arrow is normal to the torus plane).

class v_sim.FileFormatErrorFlag(value)

Bases: GLib.Enum

These are flags used when reading a file with a loading method associated to a file format.

METHOD = 0

Error from the loading method.

FILE = 1

Error when opening.

FORMAT = 2

Wrongness in format.

CANCEL = 3

Cancellation occurs.

UNKNOWN_FORMAT = 4

the file is not recognised.

class v_sim.FortranEndianId(value)

Bases: GLib.Enum

Thiese ids are used when reading a multi-bytes information from a binary file.

KEEP = 0

read a file without inverting records.

CHANGE = 1

read a file inverting records.

class v_sim.GlArrowCentering(value)

Bases: GLib.Enum

The way to draw arrows (see v_sim.Gl.drawSmoothArrow() for instance).

ORIGIN_CENTERED = 0

the arrows are positioned with respect to the point between tail and hat.

BOTTOM_CENTERED = 1

the arrows are positioned with respect to the bottom of the arrow ;

TAIL_CENTERED = 2

the arrows are positioned with respect to the center of the tail part ;

CENTERED = 3

the arrows are centered.

class v_sim.GlExtInfosDrawId(value)

Bases: GLib.Enum

This enum represents the possibilities for the information drawing.

NEVER = 0

don’t draw any information on nodes ;

SELECTED = 1

draw information only on a list of nodes ;

ALWAYS = 2

draw information on all nodes.

class v_sim.GlExtMarksHidingModes(value)

Bases: GLib.Enum

Possible parameters used by v_sim.GlExtMarks.setHidingMode().

New in version 3.8.

NONE = 0

don’t hide nodes.

HIGHLIGHT = 1

hide highlighted nodes.

NON_HIGHLIGHT = 2

hide all non-highlighted nodes.

class v_sim.GlExtMarksStatus(value)

Bases: GLib.Enum

Possible parameters to change mark status, see visu_gl_ext_marks_setHighlightedList() for instance.

New in version 3.6.

KEEP = 0

do not change the status of the mark ;

TOGGLE = 1

change the status of the mark ;

SET = 2

set the mark on ;

UNSET = 3

unset a mark.

class v_sim.GlExtNodeVectorsColorScheme(value)

Bases: GLib.Enum

Different colour schemes used to colourize the vectors.

New in version 3.8.

ELEMENT = 0

use the v_sim.Element colour for vectors.

BRIGHT = 1

use a bright colour derived from the v_sim.Element colour for the vectors.

ORIENTATION = 2

use the orientation to colour the vectors.

class v_sim.GlNodeSceneColorizationPolicies(value)

Bases: GLib.Enum

The different policies to apply when a new v_sim.Data is associated to a v_sim.GlNodeScene object.

New in version 3.8.

POLICY_NONE = 0

no policy.

POLICY_FROM_FILE = 1

try to load colourisation data from file matching file name.

POLICY_FROM_PREVIOUS = 2

copy previous colourisation data to new v_sim.Data.

class v_sim.GlRenderingMode(value)

Bases: GLib.Enum

Implemented mode to draw objects.

WIREFRAME = 0

objects are rendered with lines only ;

FLAT = 1

objects are rendered with polygons whose colours are uniform on each polygon ;

SMOOTH = 2

objects are rendered with polygons whose colours are shaded to be smooth all along the object.

SMOOTH_AND_EDGE = 3

objects are rendered with lines hightlighting the contours of polygons.

N_MODES = 4

number of rendering mode.

FOLLOW = 5

use this value not to choose any rendering mode.

class v_sim.GlTextSize(value)

Bases: GLib.Enum

Different text size available in V_Sim.

NORMAL = 0

normal size (14) ;

SMALL = 1

small text (12).

class v_sim.InteractiveId(value)

Bases: GLib.Enum

These are the possible mouse interaction that are implemented.

NONE = 0

no interaction ;

OBSERVE = 1

interaction to rotate the view ;

MEASUREANDOBSERVE = 2

interaction to rotate the view and access limited pick action on the right click ;

MEASURE = 3

interaction to pick and measure ;

PICK = 4

interaction to select node ;

MOVE = 5

interaction to move nodes ;

MARK = 6

interaction to mark nodes ;

DRAG = 7

interaction to get drag moves of the mouse.

class v_sim.InteractiveMethod(value)

Bases: GLib.Enum

Describes the different possible methods for observe moves.

CONSTRAINED = 0

the camera is moved keeping the north pole up. The north pole is defined by the Z axis et periodic boundary conditions and by normal to surface in surface conditions.

WALKER = 1

the camera is moved following the mouse moves, orienting the view as a walker would do along a sphere.

class v_sim.InteractivePick(value)

Bases: GLib.Enum

Possible significations of a click.

NONE = 0

click to void ;

SELECTED = 1

click to select one node ;

REGION = 10

click to select a list of nodes.

DISTANCE = 2

click to measure a distance between two nodes ;

ANGLE = 3

click to measure an angle ;

HIGHLIGHT = 4

click to highlight a node ;

REFERENCE_1 = 5

click to select a first reference ;

UNREFERENCE_1 = 6

click to un-select a first reference ;

REFERENCE_2 = 7

click to select a second reference ;

UNREFERENCE_2 = 8

click to un-select a second reference ;

INFORMATION = 9

click to measure distances and angles around one node ;

class v_sim.InteractivePickError(value)

Bases: GLib.Enum

Possible errors to occur when pick or measure.

NONE = 0

no error during click ;

NO_SELECTION = 1

click to sleect but nothing selected ;

SAME_REF = 2

click to set a reference but reference already exists ;

REF1 = 3

click to select a first reference but impossible to choose this one ;

REF2 = 4

the same for second reference.

class v_sim.MapExportFormat(value)

Bases: GLib.Enum

Possible export for the map, see v_sim.Map.export().

New in version 3.6.

SVG = 0

SVG export ;

PDF = 1

PDF export.

class v_sim.MaterialIds(value)

Bases: GLib.Enum

This enum is used to address the OpenGL parameters for light rendering.

AMB = 0

the ambient identifier ;

DIF = 1

the diffuse identifier ;

SHI = 2

the shiningness identifier ;

SPE = 3

the specular identifier ;

EMI = 4

the emissivity identifier ;

N_VALUES = 5

number of used material identifiers.

class v_sim.MatrixScalingFlag(value)

Bases: GLib.Enum

Flag used to specify the transformation for maps, see scalarFieldDraw_map() routine.

New in version 3.4.

LINEAR = 0

a linear convertion from [min,max] to [0,1] ;

LOG = 1

a TOOL_MATRIX_SCALING_LOGic transformation from [min,max] to [0,1], the formula is -(f(x) - f(m) / f(m) where f(x) = ln((x-xmin)/(xmax-xmin)) ;

ZERO_CENTRED_LOG = 2

a TOOL_MATRIX_SCALING_LOGic transformation for data that are zero centred, the formula is 0.5+s*(log(MAX*SEUIL)-log(max(abs(x),MAX*SEUIL)))/(2*log(SEUIL)) where s is the sign, max=max(xmax,-xmin) and seuil a parameter (1e-5).

N_VALUES = 3

number of available scale functions.

class v_sim.MatrixSphericalCoord(value)

Bases: GLib.Enum

This is used to access the ordering of the vectors with v_sim.matrix_cartesianToSpherical() or with v_sim.matrix_sphericalToCartesian().

New in version 3.6.

MODULUS = 0

the modulus of a spherical vector.

THETA = 1

the theta angle of a spherical vector.

PHI = 2

the phi angle of a spherical vector.

class v_sim.MethodSpinDrawingPolicy(value)

Bases: GLib.Enum

Different policy to render the spin when the modulus is null. This policy is applied for all v_sim.Element.

ALWAYS = 0

Arrows are drawn whatever the modulus value.

HIDE_NULL = 1

Spin with a null modulus are hidden.

ATOMIC_NULL = 2

Follow atomic method for null modulus.

N_MODES = 3

a flag to count the number of modes.

class v_sim.MethodSpinModulusPolicy(value)

Bases: GLib.Enum

Different policy to render the spin depending on the modulus.

CONSTANT = 0

arrows have all the same size, whatever the modulus value.

PER_TYPE = 1

arrows are scaled per node type.

GLOBAL = 2

arrows are scaled globaly.

N_MODULUS_MODES = 3

a flag to count the number of modes.

class v_sim.NodeArrayIterType(value)

Bases: GLib.Enum

The kind of iterator to be used on v_sim.Data objects.

New in version 3.6.

NODES_BY_TYPE = 0

run on nodes, as V_Sim internal storage, fastest.

NODES_BY_NUMBER = 1

run on nodes as entered in the input file.

NODES_FROM_LIST = 2

run on nodes as given in a GLib.List.

NODES_FROM_ARRAY = 3

run on nodes as given in a GLib.Array.

NODES_VISIBLE = 4

run on visible nodes only (internal sort).

NODES_ORIGINAL = 5

run on original nodes only (internal sort).

NODES_FOR_ELEMENT = 6

run on all nodes of a specific element.

ELEMENTS = 7

run on elements only.

class v_sim.PairCylinderColorId(value)

Bases: GLib.Enum

Possible flags to colourise the cylinder pairs.

COLOR_USER = 0

color is chosen by the user.

COLOR_ELEMENT = 1

color is chosen according to the color of the v_sim.Element the pair is linked to.

COLOR_NODE = 2

color is chosen according to the color of the v_sim.Node the pair is linked to (relevant whenever nodes are colorized).

N_COLOR = 3

number of choices for the colourisation.

class v_sim.PairLinkDistances(value)

Bases: GLib.Enum

This is useful with the v_sim.PairLink.getDistance() and the v_sim.PairLink.setDistance() methods.

New in version 3.8.

MIN = 0

Flag used to define the minimum length to draw pair.

MAX = 1

Flag used to define the maximum length to draw pair.

class v_sim.PlaneSetHiddingEnum(value)

Bases: GLib.Enum

Enum used to address different hiding modes. See v_sim.PlaneSet.setHiddingMode() for further details.

UNION = 0

element are masked if one plane at least mask it ;

INTER = 1

element are masked if all planes mask it ;

N_VALUES = 2

number of masking possibilities.

class v_sim.PoleOrder(value)

Bases: GLib.Enum

Various pole orders.

New in version 3.8.

MONOPOLE = 0

a mono-pole.

DIPOLE = 1

a di-pole.

QUADRUPOLE = 2

a quadru-pole.

class v_sim.ScalarFieldBinaryOpTypes(value)

Bases: GLib.Enum

Defines the kind of implemented binary operation.

New in version 3.8.

ADDITION = 0

an addition binary operation.

DIFFERENCE = 1

a difference binary operation.

PRODUCT = 2

a multiplication binary operation.

RATIO = 3

a division binary operation.

class v_sim.ScalarFieldDataOrder(value)

Bases: GLib.Enum

Ordering of 3D data.

XYZ = 0

packed data are ordered x first.

ZYX = 1

packed data are ordered z first.

class v_sim.ScalarFieldMeshFlags(value)

Bases: GLib.Enum

flag (comment) standing at the begining of a Scalar field file, that gives informations concerning the mesh.

UNIFORM = 0

the mesh has constant divisions along x, y and z axis ;

NON_UNIFORM = 1

the mesh has non linear divisions along x, y or z axis.

class v_sim.ScalingId(value)

Bases: GLib.Enum

Control how input data are converted into [0;1], after conversion, values are clamped if needed.

NORMALIZE = 0

input data are converted into [0;1] using input min/max values.

MINMAX = 1

input data are converted into [0;1] using user defined min/max values.

class v_sim.ShadeColorMode(value)

Bases: GLib.Enum

Defines color mode : Red-Green-Blue or Hue-Saturation-Value.

RGB = 0

variation described in the shade are applied to RGB coding colors ;

HSV = 1

variation described in the shade are applied to HSV coding colors ;

N_VALUES = 2

number of modes available.

class v_sim.ShadeMode(value)

Bases: GLib.Enum

Defines the storage of the shade mode.

LINEAR = 0

all channels are defined by a linear variation Ax+B ;

ARRAY = 1

all channels are defined by a given array of values ;

N_VALUES = 2

the number of different shade mode.

class v_sim.SpecialKeyStroke(value)

Bases: GLib.Enum

Possible non ascii keys used in v_sim.SimplifiedEvents.

NONE = 0

no key pressed ;

PAGE_UP = 1

key up ;

PAGE_DOWN = 2

key down ;

ARROW_LEFT = 3

key left ;

ARROW_RIGHT = 4

key right ;

ARROW_UP = 5

key up ;

ARROW_DOWN = 6

key down ;

MENU = 7

key menu.

class v_sim.UiBoxFit(value)

Bases: GLib.Enum

Possible value to adapt the boxes of structure and field.

New in version 3.7.

NO_FIT = 0

don’t change the box.

FIT_TO_BOX = 1

adapt the box of the field to the box of the loaded v_sim.Data.

FIT_TO_SURFACE = 2

adapt the box of the loaded v_sim.Data to the box of the field.

class v_sim.UiDirectoryType(value)

Bases: GLib.Enum

V_Sim remembers the last open directory when presenting a new file selector. This enum is used to specify different kind of directories. Like that saving a configuration file in a given directory will not affect the prefered directory for browsing a list of files.

FILE = 0

default kind of directory ;

SURFACE = 1

directory for surfaces ;

DATAFILE = 2

directory for data files ;

CONF = 3

directory for configuration files ;

BROWSER = 4

directory used in the browser.

class v_sim.UiPanelPlanesColumnId(value)

Bases: GLib.Enum

Thesse are the description of the columns stored in the Gtk.ListStore of this panel. See v_sim.UiPanel.planes_getList() to access this liststore.

POINTER = 0

the pointer to the v_sim.Plane object.

NOTIFY = 1

a handler of the v_sim.Plane ::notify signal.

N_COLUMNS = 2

the number of columns.

class v_sim.UiPlaneListColumnId(value)

Bases: GLib.Enum

Thesse are the description of the columns stored in the object.

POINTER = 0

the pointer to the v_sim.Plane object.

NOTIFY = 1

a handler of the v_sim.Plane ::notify signal.

MODE = 2

cache the hidding side of the plane when plane is not hiding.

N_COLUMNS = 3

the number of columns.

class v_sim.UiSelectionColumnId(value)

Bases: GLib.Enum

Thesse are the description of the columns stored in the object.

NUMBER = 0

column displaying the node id.

HIGHLIGHT = 1

column checked when the node is highlighted.

N_COLUMNS = 2

the number of columns.

class v_sim.UiSurfacesFieldId(value)

Bases: GLib.Enum

Thesse are the description of the columns stored in the Gtk.ListStore of this panel. See v_sim.UiPanel.surfaces_getFields() to access this liststore.

LABEL = 0

a string, the description of the scalar field.

ROW = 1

a column storing internal pointers.

N_COLUMNS = 2

the number of columns.

class v_sim.Units(value)

Bases: GLib.Enum

The possible length units defined in V_Sim. The special case v_sim.Units.UNDEFINED means that a unit must be defined before any conversion operations may be done.

New in version 3.5.

UNDEFINED = 0

the units are undefined.

BOHR = 1

the length are given in Bohr (1ang = 0.529177Bohr);

ANGSTROEM = 2

the length are given in angstroems ;

NANOMETER = 3

the length are given in nanometers.

class v_sim.XyzDir(value)

Bases: GLib.Enum

The three space axis.

New in version 3.8.

X = 0

the x axis;

Y = 1

the y axis;

Z = 2

the z axis.