v_sim.GlExtMarks¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r/w |
GlView mark labels are aligned with |
||
r/w |
nodes hiding property |
||
r/w |
node ids with highlight mark. |
||
r/w |
Interactive the marks react on |
Signals¶
- Inherited:
Name |
Short Description |
|---|---|
The list of measurements has been changed. |
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
|---|---|---|---|
parent |
r |
Class Details¶
- class v_sim.GlExtMarks(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
All fields are private.
New in version 3.6.
- classmethod new(name)¶
- Parameters:
name (
strorNone) – a possible name for thev_sim.GlExt.- Returns:
the newly created object.
- Return type:
Create a new
v_sim.GlExtMarksobject. Make it listen tov_sim.Interactive::node-selectionsignal to update itself automatically.
- exportXMLFile(filename, nodes, drawingMode, drawingInfos)¶
- Parameters:
filename (
str) – a location to save to.nodes ([
int]) – an array of node ids.drawingMode (
v_sim.GlExtInfosDrawId) – a flag.drawingInfos (
int) – a flag.
- Raises:
- Returns:
Trueif no error.- Return type:
This routines export to an XML file a description of selected nodes. If nodes is
None, the nodes stored in the mark will be used instead.New in version 3.5.
- getActive(nodeId)¶
- Parameters:
nodeId (
int) – a node id.- Returns:
Trueif nodeId participate to any mark (distance, angle…).- Return type:
Retrieve if nodeId is implied any measurement marks stored in mark.
- getHidingMode()¶
- Returns:
a
v_sim.GlExtMarksHidingModesvalue.- Return type:
Retrieves the hiding mode of self, see
v_sim.GlExtMarksHidingModes.New in version 3.8.
- getHighlightStatus(nodeId)¶
- Parameters:
nodeId (
int) – a node id (ranging from 0).- Returns:
Trueif nodeId has an highlight.- Return type:
Nodes can be highlighted.
New in version 3.7.
- getHighlighted()¶
- Returns:
list of highlighted nodes (starting from 0), should not be freed.
- Return type:
[
int]
self has a list of mark for some nodes. These marks are only highlight marks.
New in version 3.6.
- getInternalList()¶
- Returns:
a
v_sim.GlExtobject.- Return type:
Return an additional list used internaly.
New in version 3.7.
- getMeasurementLabels()¶
- Returns:
a newly allocated string.
- Return type:
Exports as a string the ids of nodes for measurement marks.
New in version 3.6.
- getMeasurementStrings()¶
- Returns:
a newly allocated string.
- Return type:
Exports as a string all measurements stored in self.
New in version 3.6.
- parseXMLFile(filename, drawingMode, drawingInfos)¶
- Parameters:
filename (
str) – a location to save to.drawingMode (
v_sim.GlExtInfosDrawId) – a location to a flag.drawingInfos (
int) – a location to a flag.
- Raises:
- Returns:
Trueif no error.- infos:
a location to a
GLib.List.
- Return type:
This routines read from an XML file the description of selected nodes, mark is updated accordingly.
New in version 3.5.
- removeMeasures(nodeId)¶
-
This routine scans the mark to remove all marks of distance or angle where nodeId is implied in.
- setDataRenderer(renderer)¶
- Parameters:
renderer (
v_sim.NodeArrayRenderer) – av_sim.NodeArrayRendererobject.
Attach the given self to data. self will be updated if data is changed and internal list of marks is updated with the new nodes of data.
- setDrawValues(status)¶
-
Change if the measurements are printed or not (distance length, or angles…).
- setHidingMode(mode)¶
- Parameters:
mode (
v_sim.GlExtMarksHidingModes) – av_sim.GlExtMarksHidingModesvalue.- Returns:
Trueif value is actually changed.- Return type:
Change the hiding mode of self.
- setHighlight(nodes, status)¶
- Parameters:
nodes ([
int]) – a set of node ids (0 started) ;status (
v_sim.GlExtMarksStatus) – changing command.
- Returns:
Trueif redraw needed.- Return type:
self has a list of mark for some nodes. These marks can be highlight (or distance, angles…). Depending on status values, the mark may be switch on or off.
New in version 3.6.
- setInfos(nodeId, status)¶
- Parameters:
- Returns:
Trueif self is changed.- Return type:
Depending on status, it removes all measurements from nodeId or it calculate all first neighbour relations of nodeId.
- setInteractive(inter)¶
- Parameters:
inter (
v_sim.InteractiveorNone) – av_sim.Interactiveobject.
Listen to
v_sim.Interactive::node-selectionsignal to update self.New in version 3.7.
Signal Details¶
- v_sim.GlExtMarks.signals.measurementChanged(gl_ext_marks, data)¶
- Signal Name:
measurementChanged- Flags:
- Parameters:
gl_ext_marks (
v_sim.GlExtMarks) – The object which received the signaldata (
v_sim.Data) – thev_sim.Datathe measurement is done on.
The list of measurements has been changed.
New in version 3.6.
Property Details¶
- v_sim.GlExtMarks.props.gl_view¶
- Name:
gl-view- Type:
- Default Value:
- Flags:
GlView mark labels are aligned with
- v_sim.GlExtMarks.props.hiding_mode¶
-
nodes hiding property
- v_sim.GlExtMarks.props.highlight¶
- Name:
highlight- Type:
- Default Value:
- Flags:
node ids with highlight mark.
- v_sim.GlExtMarks.props.interactive¶
- Name:
interactive- Type:
- Default Value:
- Flags:
Interactive the marks react on