InsertPlotSymbol

SUMMARY

The defined Plot Symbol is set.

SYNTAX

For Plot Symbols:

- placed directly in the ship plan without a connection line:
InsertPlotSymbol2D(<class, symbol_figure, context_figure, cur_file>);


- placed above or below the ship plan with a connection line:
InsertPlotSymbol3D(<class, symbol_figure, context_figure, cur_file>);

ARGUMENTS

class (type:string)
The user defined Data-Object class that administrates the damage data. On placing the Plot Symbol an instance of this class is created.

Such a class must have the following properties:

  • ContextFigure (String)
    The name of the figure for the context menu of the damage. The value is taken from the according argument of the InsertPlotSymbol-Job.
  • SymbolFigure (String)
    The name of the figure for the Plot Symbol of the damage. The value is taken from the according argument of the InsertPlotSymbol-Job.
  • Room (String)
    The name of the room the damage occurred. The value is taken from the according property of the room polygon.
  • Section (String)
    The name of the section the damage occurred. The value is taken from the according property of the room polygon.
  • Deck (String)
    The name of the deck the damage occurred. The value is taken from the according property of the room polygon.
  • Display (String)
    The name of the picture the Plot Symbol was placed in.
  • RoomPolyName (String)
    The name of the selected room polygon. This value is handled internally.
  • Dimension (Integer)
    This value is set by the program, depending on the Insert-Job (InsertPlotSymbol3D or InsertPlotSymbol2D).
  • LineStartX and LineStartY (Integer)
    The x/y coordinate of the start point of the connection line between Plot Symbol and room (3D) respectively the Hotspot of the Plot Symbol (2D).
    The value is internally calculated.
  • Created (Time)
    The time is automatically set on placing the symbol.
  • Triggered (bool)
    Indicates whether a damage was plotted automatically. Internally calculated.

If a class is used with the “InsertPlotSymbol3D” -job the following elements must be contained in addition:

  • LineEndX and LineEndY (Integer)
    The x/y coordinate of the end point of the connection line between Plot Symbol and room.
    The value is internally calculated internally.
  • DamageType (String, Constant)
    The damage type (Fire, Water, ABC ...) of the Plot Symbol class. When creating it is defined as a default value.
  • LineColor (String, Constant)
    The color this Plot Symbol class uses to draw the connecting line between symbol and room. When creating it is defined as a default value.

The Data-Object of the actual selected damage can be addresses via BDC.ActDamage.

symbol_figure (type:string)
The figure (only the name, not the file) for the Plot Symbol. Within that file the damage object is addressed by the automatically created formal parameter ‘damage’.
context_figure (type:string)
The figure (only the name, not the file) for the Context Menu. This text is saved to the property ‘ContextFigure’ of the damage Data-Object and is used to switch the figure for the Context Menu.
cur_file (type:string)
The file name for the cursor to display relative to the project folder. The file must be found in the project folder or a subdirectory to it. It is possible to have animated cursors.
check_existing_plotsym (type:bool)
If this parameter is unequal to null nothing is plotted, in case the room already contains a Plot Symbol of the same context_figure.

DESCRIPTION

Effect
The mouse pointer turns into the defined cursor. Now the user may click into a room of the BDCRUN-Application in the right window. Hereupon the Plot Symbol (Figure 'symbol_figure') is placed in that room. If the room name could be ascertained it is returned via the stack. The Context Menu is switched also. (Assuming it is set up that way)

If the room already contains a plot symbol with the same context_figure no new symbol is plotted.

EXAMPLES

Icon (Button) in the icon bar: (Action) 

//The cursor is found in the subdirectory Cursors
InsertPlotSymbol("FDamage", "FDamageSymbol", "FDamageContext", "Cursors\F.cur");

Places the figure for the Context Menu: (Refresh) 
SetVal(Figure, BDC.ActDamage.ContextFigure);

Grafic Objects within the Context Menu Figure: e.g. Displays the room in a text: (Refresh) 
SetVal(Text, BDC.ActDamage.Room);

Grafic Objects within the Plot Symbol Figure: e.g. Displays the actual damage by a rectangle: (Refresh) 
SetVal(Text,Damage.Medium);

Syntax Notation
[aaa]
aaa is optional (zero or one occurences)
(aaa|bbb)
aaa exclusive or bbb
(aaa)*
aaa may occur indefinitely often or may be omitted
(aaa)+
aaa may occur indefinitely often but at least once
(aaa)m..n
aaa may occur from m to n times