Documentation for Axxon PSIM 1.0.0-1.0.1.

Previous page CORE  OLXA_LINE Microphone Next page


The MAP object corresponds to the Map system object.

The MAP object sends the events presented in the table. The procedure is started when the corresponding event occurs.

EventDescription
LAYER_ACTIVATEDLayer activation. This event is received when a layer is selected on the Map. The obj_id<> parameter has the ID of the activated layer
ACTIVATE_OBJECT

Object activation. The event is received when an object is selected (activated by mouse click) on the Map.

Parameters:

  1. obj_type <>—object type
  2. user_id<>—user ID
  3. module<>—module name, for the Map—map.run
  4. date<>—date when the event occurred
  5. time<>—time when the event occurred
  6. slave_id<>—computer network name
  7. obj_id <>—object ID
  8. layer<>—Map layer ID
  9. fraction<>—millisecond when the event occurred
  10. owner<>—user who activated the object
  11. type_of_display <>—object display type, possible values:
    1. IMAGE—image
    2. IMAGE_AND_INDICATOR—image and indicator
    3. TEXT—text
    4. LINE—line
    5. POLYGON—polygon
    6. ELIPSIS—ellipse
    7. TITLE—the name of the object
OBJDBLCLKThe event is received when you double click an object on the Map. Contains the same parameters as ACTIVATE_OBJECT

The list of commands and parameters for the MAP object is presented in the table.

Command

Parameters

Description

SET_TOPMOST—Set topmost

-

-

SET_NOTOPMOST—Cancel topmost

-

-

HIDE_OBJECT—Hide/show object icon on the map

objtype<>

Object type. Can be left blank. If the object type is not set, then objects of all types are hidden/shown

objid<>

Object ID. Can be left blank. If the object ID is not set, then all objects of the specified type are hidden/shown

hide<>

0—objects are shown on the map

1—objects are hidden on the map

SET_OBJECT_GEOMETRY—Set object location on the map





objtype<>

Object type

objid<>

Object ID

x<>

New coordinate of the top left corner of the object icon on the map layer along the X axis in pixels

y<>

New coordinate of the top left corner of the object icon on the map layer along the Y axis in pixels

exclude_children<>

By default, when using the SET_OBJECT_GEOMETRY reaction, when moving the object icons, the names of these objects (child objects) also move. If you pass the exclude_children <1> parameter in the reaction, then the object is moved separately from the children, that is, without their names

INSCRIBE—Inscribe to window--
SHOW_MINIMAP—Show a minimapx<>The coordinate of the top left corner of the minimap along the X axis in pixels
y<>The coordinate of the top left corner of the minimap along the Y axis in pixels
w<>Width of the minimap in pixels
h<>Height of the minimap in pixels
monitor<>Monitor ID
slave_id<>Computer network name
SET_ZOOM—Change the Map scalezoom<>Map scale ratio
ACTIVATE_OBJECT—Activate object on the Mapobj_type<>Object type
obj_id<>Object ID
layer<>Map layer ID. If the parameter is set, the script will work on the specified layer. If the parameter is not set, the scrip will work on the current layer
DRAW_ARROW—Draw a track of movement between objects

first_obj_type<>Type of the object from which a track will be made
first_obj_id<>ID of the object from which a track will be made
second_obj_type<>Type of the object to which a track will be made
second_obj_id<>ID of the object to which a track will be made
obj_id<>ID of the created track
title_text<>

Text that will be displayed next to the track. \n is used for line break.

Additional optional parameters:

  • title_text_align—shift of the text. 0—text is displayed in the center, 1—at the beginning of the track, 2—at the end of the track
  • title_text_size—size of the text
  • title_shift_by_y—shift down of the text (may be needed when using title_text_size). Default is 40 pixels
  • title_text_color—color of the text in Decimal format
  • title_text_font—font of the text

Example:

title_text<Object is moving\nto the exit>,title_text_align<1>,title_shift_by_y<60>,title_text_color<16711935>,title_text_size<18>,title_text_font<Algerian>

ERASE_ARROW—Erase a track of movement between objectsobj_id<>ID of the track that must be erased. If you don't specify the parameter, all tracks will be erased

Features of the DRAW_ARROW command execution:

  1. When executing the command, a track will be displayed on each layer of the Map as arrows between the objects.
  2. If the objects are located on the same layer, the arrow is drawn directly between the specified objects. If the objects are located on different layers, the arrow is drawn by the shortest path.
  3. You can limit the depth of searching for connections between layers to make a track with the DrowArrowSearchDepth key, see Registry keys reference guide.
  4. If 
    1. it isn't possible to make a track,
    2. one of the objects doesn't exist,
    3. it is possible to make a track, but the arrows cannot be displayed,

then the icon will be displayed on the first object, and the icon will be displayed on the second object.

  • No labels