Broker Specific Entity Metadata

While the Common Entity Library allows for any amount of metadata to be stored in an entity, some of the fields are reserved for use by the STK Object Model Broker and have special meaning. These fields are completely optional and will only affect behavior on the entity that contains them.

Keyword Description
AGI.Stk.ForceObject If set to the value of an AgEStkObjectType enum, it causes the entity to always be represented as the provided STK object type. The entity will be unable to be demoted and no underlying MTO track will be created for it. This field is only used when the entity is added to the STK Object Model Broker; changing it or modifying it afterwards will have no affect.
AGI.Stk.ObjectHint If an entity needs to be automatically promoted by the STK Object Model Broker - for example, in order to make use of Attitude - this field, when set to the value of an AgEStkObjectType enum, causes the entity to be promoted to the provided STK object type. The entity can still be demoted manually if it meets the conditions for demotion. The field is valid at any time and can be changed at will. It will not be taken into account, however, if an entity has already been promoted. It also does not preclude someone from manually promoting the entity to a different STK object type. This field is also used as a hint in order to ensure that the model is oriented properly on the MTO track.
AGI.Stk.ObjectTemplate If set to a string indicating the full path of a value STK object file, it loads the specified file to represent the entity in STK. This object can be as complex as you want - for example, a fully configured UAV with sensors and transmitters. This field is only used when the entity is added to the STK Object Model Broker; changing it or modifying it afterwards will have no affect.
AGI.ModelOverride If set, it overrides the Model property on an IAgPointEntity and uses the IAgModelGraphics object specified within. One example use is to override the Rt3 setting for individual entities.
AGI.MarkerOverride If set, it overrides the Marker property on an IAgPointEntity and uses the IAgMarkerGraphics object specified within. One example use is to override the Rt3 setting for individual entities.
AGI.LineOverride If set, it overrides the Line property on an IAgPointEntity or IAgPolylineEntity and uses the IAgLineGraphics object specified within. One example use is to override the Rt3 setting for individual entities.
AGI.LabelOverride If set, it overrides the Label property on an IAgPointEntity or IAgPolylineEntity and uses the IAgLineGraphics object specified within. One example use is to override the Rt3 setting for individual entities.

STK 11.2.1 Programming Interface