DisplayEntity

The DisplayEntity is the basic 3D graphical object in JaamSim.  All JaamSim objects that have graphics are subclasses of DisplayEntity.

All objects intended for visualization in a model view window have a set of basic graphics keywords that are used to define their appearance.  These inputs are found in the Graphics tab of the Input Editor when the object is selected.  For normal objects, the graphics inputs are Position, Alignment, Size, and Orientation.  For polyline type objects the graphics inputs are Points and CurveType.

DisplayEntity Inputs

Keyword

Description

Normal Objects

 

Position

The location of the object in (x, y, z) coordinates.

Alignment

The point within the object that is located at the coordinates of its Position input.  Expressed with respect to a unit box centered about (0 0 0).

Size

The size of the object in (x, y, z) coordinates.  If only the x- and y-dimensions are given then the z-dimension is assumed to be zero.

Orientation

Euler angles defining the rotation of the object.

Polyline Type Objects

 

Points

A list of points in (x, y, z) coordinates that define a polyline.  When only two coordinates are given it is assumed that z = 0.

CurveType

The type of curve interpolation used for line type entities.

All Objects

 

Region

If a Region is specified, the Position and Orientation inputs for the present object are relative to the Position and Orientation of the specified Region.  If the specified Region is moved or rotated, the present object is moved to maintain its relative position and orientation.

RelativeEntity

If an object is specified, the Position input for the present object is relative to the Position for the specified object.  If the specified object is moved, the present object is moved to maintain its relative position.

DisplayModel

The graphic representation of the object.  If a list of DisplayModels is entered, each one is displayed provided that its DrawRange input is satisfied.  This feature allows the object's appearance to change with its distance from the View window's camera.

Show

If TRUE, the object is shown in the View windows.

Movable

If TRUE, the object will respond to mouse clicks and can be positioned by dragging with the mouse.

VisibleViews

The view windows on which this entity will be visible.

DrawRange

The minimum and maximum distance from the camera for which this entity is displayed.

DisplayEntity Outputs

Output Name

Description

Entity

 

Name

The unique input name for this entity.

ObjectType

The class of objects that this entity belongs to.

SimTime

The present simulation time.

Parent

The parent entity for this entity.

DisplayEntity

 

Position

The present (x, y, z) coordinates of the DisplayEntity in its Region.

Size

The present (x, y, z) components of the DisplayEntity's size.

Orientation

The present (x, y, z) Euler angles of the DisplayEntity's rotation.

Alignment

The present (x, y, z) coordinates of a point on the DisplayEntity that aligns direction with the position output. Each component should be in the range [-0.5, 0.5].

GraphicalLength

Polyline type objects: the length of the polyline determined by its Points and CurveType inputs.

Non-polyline type objects: the largest of the Size inputs.

ObserverList

The observers that are monitoring the state of this entity.

NextList

The entities that are immediately downstream from this entity.

PreviousList

The entities that are immediately upstream from this entity.

EntityReferenceList

The entities that appear in the inputs to this entity.