MarkAfflictedSection

SUMMARY

Marking an afflicted section.

SYNTAX

MarkAfflictedSection(<class, affliction_type, context_figure, cur_file>);

ARGUMENTS

class (type:string)
The user defined Data-Object class administering the damage data. On clicking to it an instance of that 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.
  • Display (String)
    The name of the picture the Plot Symbol was placed in.
  • SectionPolyName (String)
    The name of the selected section polygon. This value is handled internally.
  • DamageType
    The damage type is taken from the affliction_type argument of the MarkAfflictedSection-Job.
  • Section (String)
    The name of the section the damage occurred. The value is taken from the appropriate property of the room polygon.
  • Created (time)
    The time is automatically set on placing the symbol.

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

affliction_type (type:string)
The damage type in the afflicted section.

There are 3 types of affliction:

  • Smoke - smoked area
  • Inundation - inundated area
  • Contamination - contaminated area
    This text is stored in the property ‘DamageType’ of the damage Data-Object and serves to draw the section after a picture change.
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.

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 for that section an according affliction_type flag is set. Depending on the appropriate settings the context menu is switched and via querying the ‘affliction_type’ (Refresh-Script of the section) the color and the fill pattern of the section is set. According to the color selection a bitmap may be displayed semitransparent.
Marking a section and calling the according context menu can be repeated. (by pressing the button and clicking into the section)

EXAMPLES

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

//The cursor is found in the subdirectory Cursors
MarkAfflictedSection("Aff_Area", "Smoke", "Aff_AreaCont", "Cursors\Smoke.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.DamageType);

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