Object

Object.animations

readonly animations

Description

Accesses an object's animations.

Gives access to the animations of an object as Animation interfaces.

// Start the "Walk" animation on Operator1
Object obj = Model.find("Operator1");
obj.animations["Walk"].start();
			

Object.attrs

readonly attrs

Description

Accesses object attribute nodes.

Object obj = Model.find("Processor1");
obj.attrs.spatialx.value = 5;
      		

Object.centerObjects

readonly centerObjects

Description

Accesses objects connected through center port connections.

Accessing the Number of Center Port Connections

You can access the number of center port connections on the object with the following code.

obj.centerObjects.length

Accessing Objects by Rank

You can access an individual object connected through a center port connection by rank with the following code.

obj.centerObjects[1] // first object
obj.centerObjects[obj.centerObjects.length] // last object
obj.centerObjects[i] // i-th object
		      	

Getting an Array of Objects

You can get an Array of all objects connected through a center port connection with the following code.

Object.color

readonly Color color

Description

Get and set the Color of the object.

Object obj = Model.find("Processor1");
obj.color = Color.red;
      		

Object.flags

readonly flags

Description

Get and set flags of the object.

isProtected

Get or set the "Protected" flag of the object.

Protecting an object keeps it from being moved, rotated, or resized with the mouse, but not from being double-clicked to access the Parameters window for the object. View windows have an attribute named viewignoreobjects which can be used to ignore ALL the objects in their view which means the objects can not be manipulated in any way with the mouse including double-clicking. Protected objects will have a gray highlight in the treeview to indicate their protected status.

current.flags.isProtected = 1;

isSelected

Get or set the "Selected" flag of the object.

Selecting an object puts a red box around it in both the 3D and tree view. Dragging one selected object in the 3D view will drag all other selected objects by the same amount. The Edit Selected Objects tool allows you to quickly modify all selected objects in your model.

if(current.flags.isSelected) return 1;

showConnections

Get or set the "Show Connections" flag of the object.

Hiding the connections will turn off the display of ports and their connections both to and from the object. Note that view windows have an attribute named hideallconnectors that controls the display of connectors for ALL objects in their view.

obj.flags.showConnections = 0;

showContent

Get or set the "Show Contents" flag of the object.

Hiding the contents of an object will stop the display of objects (e.g. flowitems) contained within it.

current.flags.showContent = 0;

showName

Get or set the "Show Name" flag of the object.

A value of 1 will hide the object's name and stats from being displayed on the screen, a value of 0 will show the object's name and possibly stats depending on the viewhidealllabels attribute of the view window. The viewhidealllabels attribute of the view window has the following possible values which will apply to the label display of all objects in the window: 0=show name and stats, 1=hide name and stats, 2=show just names.

obj.flags.showName = 1;

showShape

Get or set the "Show Shape" flag of the object.

Hiding the object's shape will stop its 3D shape from drawing. Note that view windows also have an attribute called hidealldrawcontent that controls the display of 3D shapes for ALL objects in their view.

Object.inObjects

readonly inObjects

Description

Accesses objects connected through input ports connections.

Same as the centerObjects property, but for input port connections.

Object.input

readonly input

Description

Access methods on the object's input ports connections.

close

Blocks the input of the object. Only the input ports themselves, or the input in general needs to be closed to block entry. When port connections are displayed with sufficient size in the view window, you will see a small red bar drawn across all the input ports (squares) for the object, signifying the input ports are blocked. Individual ports may still be open and drawn in green, but entry to the object is still blocked because of the red bar. Compare with stop().

current.input.close();

open

Unblocks the input of the object after it has been previously blocked with the close() method. It is necessary that both the input ports themselves, and the input in general, are open before entry will be allowed. It is advised that modelers never use this method in any field other than the OnMessage field which has been triggered with the senddelayedmessage() command, because commands which open ports often spawn several other activities that shouldn't be performed during transitional events. Compare with resume().

current.input.open();

resume

Opens the input of the object just like open() does, but because it keeps track of previous stop() calls on the object, it will only open input after all stops have been resumed. Refer to open() for additional information.

current.input.resume();

stop

Closes the input of the object just like close() does, but it also keeps track of consecutive stop() calls on the object, and will only open input after all stops have been resumed. Refer to close() for additional information.

Object.location

readonly Vec3 location

Description

Get and set the position of the object.

Object obj = Model.find("Processor1");
obj.location = Vec3(0,0,0);
      		

Object.outObjects

readonly outObjects

Description

Accesses objects connected through output ports connections.

Same as the centerObjects property, but for output port connections.

Object.output

readonly output

Description

Access methods on the object's output ports connections.

Same as the input property, but for output port connections.

Object.resetPosition

readonly resetPosition

Description

Accesses an object's reset position.

Allows you to access the reset position of an object. The property can be read directly to determine if an object's reset position has been set or not.

This property provides the following properties and methods:

location - returns an object's reset position location

rotation - returns an object's reset position rotation

size - returns an object's reset position size

container - returns an object's reset position container

set() - sets an object's reset position to its current location, rotation, size, and container.

clear() - clears an object's reset position.

				Object obj = Model.find("Processor1");
				if (obj.resetPosition) //Checks to see if its reset positon has been set
					return obj.resetPosition.location;// gets the location value of the reset position
				else{
					obj.resetPosition.set();// set the reset postion on the object
					return obj.resetPosition.location; // gets the location value of the reset position
				}
			

Object.rotation

readonly Vec3 rotation

Description

Get and set the rotation of the object.

Object obj = Model.find("Processor1");
obj.rotation = Vec3(0,0,0);
      		

Object.size

readonly Vec3 size

Description

Get and set the size of the object.

Object obj = Model.find("Processor1");
int xSize = obj.size.x;
      		

Object.stats

readonly stats

Description

Allows access to an object's statistics.

Allows you to access the statistics of an object as TrackedVariable objects. This property provides the following properties and methods:

input - returns the input tracked variable

output - returns the output tracked variable

content - returns the content tracked variable

staytime - returns the staytime tracked variable

totalTravelDistance - returns the total travel distance of a Task Executer

state(Variant& profile = nullvar) - returns a state tracked variable. If no profile argument is given, or if it is 0, then the default state profile is returned. Other state profiles can be returned by providing the profile number or name.

// Get the input of a processor
Object obj = Model.find("Processor1");
double input = obj.stats.input.value;

// Get the state of a multiprocessor,
// using the multiprocessor state profile
Object obj =  Model.find("MultiProcessor1");
int curState = obj.stats.state(1).value;	
			

Object.stopCount

readonly int stopCount

Description

Gets the number of stops for the object.

This number increases with calls to the stop method, and decreases with calls to the resume method.