Entity Layout: PARAM

Synopsis

Syntax

• object_id str - The name of the entity that is associated with the parameter. This can be the type name of an entity defined in the entity library, in which case the parameter will be positioned on all the entities of that type. It can also be the instance name of the required entity. The instance name should be the complete hierarchical name. When specifying a level name from the hierarchy, the instance name, not the type name, should be used. Each level in the hierarchy should be separated by a '.', i.e. the syntax for a complete hierarchical name is:

  top_level_instance_name.next_level_name. ... .last_level_name

  The param information given to an instance overrides the param information of the library component.

• param_name str - The instance name of the parameter to be displayed.
• mode_name str - This specifies how the parameter is to be displayed. This can be one of the following:
  • VALUE: displays the parameter's value; it is updated as it changes through the animation.
  • NAME_VALUE: displays the parameter's name as well as its value.
  • ENT_ICON: allows enumerated parameters to be used to change the icon of the entity depending upon the parameter's state.
  • PORT_ICON: allows enumerated parameters to be used to change the icon of a port depending upon the parameter's state.
• Parameter position - Where a parameter is drawn on the screen depends on its modifier, i.e. on whether or not it is static.
  Non-static parameters are drawn as follows:
  • param_x int, param_y int specify the x and y coordinates of the position where the value of parameter is to be displayed. They are relative to the top left corner of the icon of the associated entity, e.g. a value of 0,0 will cause the parameter to be displayed at the top left hand corner of the entity.
  Static parameters are drawn as follows:
  • param_x int, param_y int specify the x coordinate of the position to display both the name and the value of the parameter. They are relative to the top left corner of the screen.

Example