Command: get

Parameters

{<entity> = } get <file>

Description

Create an instance entity, a reference to a previously created entity file.

Parameters

• <entity>
  An entity or gstructure identifier. The instance entity will be given this name.

• <file>
  The name of the file containing the graphics to be instantiated. The default file extension is .e

Switches

• -alph=<num>
  An alpha transparency factor between 0 and 1. A value 1 implies fully opaque, 0 means fully transparent (therefore invisible). The default is 1. This transparency will augment not replace the transpency of entities within <file>.

• -ang=<angle>
  The orientation of the instance. This is for changes in plan angle only. The X axis of entities within <file> will be with this angle.

• -ap=<num>
  The curve approximations factor for all curve-type entities within <file>. If omitted, their curve factors are unchanged.

• -br=<num>
  A brightness factor between -1 and +1. A value 0 means normal, -1 means very dark (black), +1 means very bright (white). The default is 1. This brightness will augment not replace the brightness of entities within <file>.

• -col=<color>
  The color override for all entities within <file>. If omitted, their colors are unchanged and the color override is set to no_change.

• -fil=<fillstyle>
  The fillstyle override for all facet-type entities within <file>. If omitted, their fill styles are unchanged and the fillstyle override is set to no_change. Note: <fillstyle> can be a fillstyle, color, tile, hatchstyle or graduation.

• -fr=<num>
  Define a fragment override for all entities within <file>. If omitted, their fragments are unchanged.

• -g=<groups>
  The graphic groups of which the instance entity is to be a member.

• -i=<num>
  The input attach tag (See save) within <file>, used for instance positioning. If omitted, a value of zero (the entity file origin) is used.

• -ls=<linestyle | color>
  The linestyle override for all vector-type entities within <file>. This can be a linestyle or a color. If omitted, their linestyles are unchanged and the linestyle override is set to no_change.

• -ms=<markerstyle>
  The markerstyle override for all node entities within <file>. If omitted, their marker styles are unchanged and the markerstyle override is set to no_change.

• -o=<num>
  The output attach tag within file, used for positioning graphic control after the instance has been positioned. If omitted, the value of the input attach tag is used (-i).

• -out
  Display the instance in outline only. The default is to display it in full.

• -p=<point>
  Where the input attach tag of the instance is to be positioned. If omitted, the current graphic control position is used.

• -ra=<num>
  Define a rank override for all entities within <file>. If omitted, their ranks are unchanged.

• -s=<num>
  A uniform scaling factor to be applied to all entities within <file>.

• -sh
  When entity files are processed they are mapped into memory. Applying this switch makes the memory-mapping available to other Fire processes to help reduce virtual memory usage. This can also be achieved on a permanent basis by the mapfile command. In additon, setting the the system numeric instance_automap ensures that instanced entity files remain mapped for the duration of a redraw operation, sometimes improving performance dramatically.

• -su
  Without this switch set, if the modelling units of <file> are not the same as the current modeling units, an appropriate scaling factor will be used to convert. If this switch is present no such scaling will be performed.

• -th=<num>
  The thickness override for all vector-type entities within <file>. If omitted, their thicknesses are unchanged and the thickness override is set to zero.

• -tr
  Define the instance as transparent for selection purposes. If omitted, the instance is not transparent.

• -ts=<textstyle>
  The textstyle override for all text-type entities within <file>. If omitted, their text styles are unchanged and the textstyle override is set to no_change.

• -xa=<point>

• -ya=<point>

• -za=<point>

One or more of these options will define a rotation to be applied to all entities within <file>.

• -x=<num>

• -y=<num>

• -z=<num>

Stretch factors to be applied to one or more axes. These will be applied to all entities within <file>.

Notes

This command always creates a graphic primitive.

If the <entity> = get form of the command is used, an entity identifier is also created.

Entity files may contain instances of other entity files to a depth of 32.

Examples

Create an unnamed instance.

get myfile

Create a named instance with change of position and orientation.

entity obj=get /usr/models/myfile,-p=(100,200),-ang=45

See Also