Class Load

Inheritance

System.Object

Load

Box

Implements

ILoad

System.IDisposable

ILabel

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Experior.Core.Loads

Assembly: Experior.Core.dll

Syntax

[TypeConverter(typeof(ObjectConverter))]
public abstract class Load : ILoad, IDisposable, ILabel

Constructors

Load(LoadInfo)

Constructor for Load, takes a LoadInfo as parameter.

For information about the Load class see Load.

For information about LoadInfo see LoadInfo.

Declaration

public Load(LoadInfo info)

Parameters

Type	Name	Description
LoadInfo	info	TODO

Properties

ActionPoint

Last entered routing action point.

Declaration

[Browsable(false)]
public ActionPoint ActionPoint { get; }

Property Value

Type	Description
ActionPoint

Angle

Use Yaw instead.

Declaration

[Browsable(false)]
[Obsolete("Use Yaw instead", true)]
public virtual float Angle { get; set; }

Property Value

Type	Description
System.Single

AngularVelocity

Declaration

[Browsable(false)]
public Vector3 AngularVelocity { get; set; }

Property Value

Type	Description
System.Numerics.Vector3

BlockedBySpacing

If true: The load is not allowed to move because it is not clear of spacing distance. (only when moving on a Route)

Declaration

[Browsable(false)]
public bool BlockedBySpacing { get; }

Property Value

Type	Description
System.Boolean

CenterOfMassOffsetLocalPosition

Declaration

[PropertyOrder(0)]
public Vector3 CenterOfMassOffsetLocalPosition { get; set; }

Property Value

Type	Description
System.Numerics.Vector3

Collision

When the physics engine applies a force to a load to make it moving it applies this force into the center of mass of a load. By default a loads density is equally distributed over the whole volume of the load and hence the center of mass of the load is also the geometrical center of the load. By providing the CenterOfMassOffsetLocalPosition you make it possible to move this center of mass and e.g. put the center of mass lower than the geometrical center to decrease the collapsing of a load. Note: The value provided to this property is an absolute value. The CenterOfMassOffsetLocalPosition property provided in the property window of a feed is a relative one where 1 represents 100%.

Declaration

[Browsable(false)]
public bool Collision { set; }

Property Value

Type	Description
System.Boolean

Color

Returns/sets the normal color of the load (when not selected or highlighted).

Declaration

[Browsable(false)]
public virtual Color Color { get; set; }

Property Value

Type	Description
System.Windows.Media.Color

Count

Holds the count for the current number of loads.

Declaration

public static int Count { get; }

Property Value

Type	Description
System.Int32

CurrentActionPoint

Current action point. The load is currently at this action point.

Declaration

[Browsable(false)]
public ActionPoint CurrentActionPoint { get; }

Property Value

Type	Description
ActionPoint	The current action point for this load.

Deletable

Property to indicate whether the load can be deleted. If false then the load will only be deleted if the scene is cleared.

Declaration

[Browsable(false)]
public bool Deletable { get; set; }

Property Value

Type	Description
System.Boolean	`true` if deletable; otherwise, `false`.

Density

Gets or sets the density in kilogram per cubic meter. This represents the (uniform) density of the load.

Declaration

[Browsable(false)]
public float Density { get; set; }

Property Value

Type	Description
System.Single	The density in kilogram per cubic meter.

Detail

Declaration

[Browsable(false)]
public string Detail { get; set; }

Property Value

Type	Description
System.String

Disposed

This property is true after Dispose() has been called on the load.

Declaration

[Browsable(false)]
public bool Disposed { get; }

Property Value

Type	Description
System.Boolean

Distance

Gets or sets the distance in meters.

Declaration

[Browsable(false)]
public float Distance { get; set; }

Property Value

Type	Description
System.Single	The distance in meters.

Exceptions

Type	Condition
System.Exception	Load.Distance can not exceed load.Route.Length or be less than 0!

Embedded

This indicates whether the load is embedded in another entity and hence whether it should be saved when saving the model. When the Embedded property is true the load is not saved. (In discrete mode loads are never saved).

Declaration

[Browsable(false)]
public bool Embedded { get; set; }

Property Value

Type	Description
System.Boolean

Enabled

Setting Enabled to false is similar to calling Sleep() and setting Enabled to True is similar to calling WakeUp().

Declaration

[Browsable(false)]
public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean

EntityId

Declaration

[Browsable(false)]
public uint EntityId { get; }

Property Value

Type	Description
System.UInt32

FollowLoad

The Environment.Scene.Camera will follow the given load, using the Follow(IMeshObject) method.

Declaration

public static ILoad FollowLoad { get; set; }

Property Value

Type	Description
ILoad	The load the camera will follow.

Friction

The loads friction as given by the loads Part (in Newton (N)).

For more information on friction see Friction.

Declaration

[Browsable(false)]
public IFriction Friction { get; set; }

Property Value

Type	Description
IFriction

Grouped

Returns the collection of loads that are grouped with the current load (the parent load). The Grouped collection allows to request the Length, Width, Height of the combined grouped load and you can iterate over all slave loads using the Items property of the Grouped property of the parent load.

Declaration

[Browsable(false)]
public IReadOnlyCollection<Load> Grouped { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyCollection<Load>

Height

Height of the load in meters.

Declaration

[Browsable(false)]
public virtual float Height { get; }

Property Value

Type	Description
System.Single

Identification

Is a System.String property generally used for barcodes for loads. Used for some sensors/scanners.

Also used when an ActionPoint has been entered to write into the log if in Detailed mode.

Declaration

[PropertyOrder(1)]
[Display(Order = 0, GroupName = "Identification")]
[AlwaysEditable]
public virtual string Identification { get; set; }

Property Value

Type	Description
System.String

Info

Reference to the loads info class. It is set on load creation.

Declaration

[Browsable(false)]
public LoadInfo Info { get; }

Property Value

Type	Description
LoadInfo

InQueue

This getter property returns whether the load is in queue on a non-Accumulating route.

Declaration

[Browsable(false)]
public bool InQueue { get; }

Property Value

Type	Description
System.Boolean	Is `true` if the load is on a non-Accumulating route and NonAccumulationBlocked is true.

IsAttached

This getter property returns true when the load is currently attached to a RigidPart and hence following the movement of this part.

Declaration

[Browsable(false)]
public bool IsAttached { get; }

Property Value

Type	Description
System.Boolean

IsGrouped

Returns true for a load that has been grouped with a parent load. The parent load itself will return false for this IsGrouped property. The parent load will hold a reference to each child load in Grouped

Declaration

[Browsable(false)]
public bool IsGrouped { get; }

Property Value

Type	Description
System.Boolean

Items

A collection that holds every load.

Declaration

public static ILoadCollection Items { get; }

Property Value

Type	Description
ILoadCollection

Kinematic

By default a load is a dynamic object by the PhysX engine which implies that its position and orientation will be determined by the physics engine by calculating all forces/torques applied to the load.

By setting the Kinematic property to true, the load is made a kinematic object instead of a dynamic one.

This implies that the load will no longer respond to the forces applied to it and the position and orientation of the load is controlled by the user.

Declaration

[Browsable(false)]
public bool Kinematic { get; set; }

Property Value

Type	Description
System.Boolean

Length

Length of the load in meters.

Declaration

[Browsable(false)]
public virtual float Length { get; }

Property Value

Type	Description
System.Single

LinearDamping

Declaration

[Browsable(false)]
public float LinearDamping { set; }

Property Value

Type	Description
System.Single

LinearVelocity

Declaration

[Browsable(false)]
public Vector3 LinearVelocity { get; set; }

Property Value

Type	Description
System.Numerics.Vector3

LoadTypes

Declaration

[Browsable(false)]
public static Dictionary<string, Type> LoadTypes { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Type>

LocalOrientation

Gets the local orientation of the load as a System.Numerics.Matrix4x4.

Declaration

[Browsable(false)]
public Matrix4x4 LocalOrientation { get; }

Property Value

Type	Description
System.Numerics.Matrix4x4	The local orientation of the load.

Exceptions

Type	Condition
System.Exception	The load has to be attached to a part or child in a group of loads to be able to use LocalOrientation

LocalPosition

Gets or sets the local position of the load.

Declaration

[Browsable(false)]
public Vector3 LocalPosition { get; set; }

Property Value

Type	Description
System.Numerics.Vector3	The local position of the load.

Exceptions

Type	Condition
System.Exception	The load has to be attached to a part or child in a group of loads to be able to use LocalPosition

Movable

If this property is set to true then the load cannot be moved by the user.

Declaration

[Browsable(false)]
public bool Movable { get; set; }

Property Value

Type	Description
System.Boolean

MoveLoadTo

When set this property will call MoveTo(String) setting the Path of the load to move towards the given ActionPoint. Then Release() the load so it will move towards its destination. Get on this property will return the last Path for the load.

Declaration

[PropertyAttributesProvider("DynamicPropertyMoveLoadTo")]
protected virtual string MoveLoadTo { get; set; }

Property Value

Type	Description
System.String

NextActionPoint

Next action point to enter.

Declaration

[Browsable(false)]
public ActionPoint NextActionPoint { get; }

Property Value

Type	Description
ActionPoint	The next action point.

ObjectType

Gets the System.Type of the load as a string.

Declaration

[Display(Order = 0, GroupName = "Identification")]
[PropertyOrder(0)]
public string ObjectType { get; }

Property Value

Type	Description
System.String

OccupyingDistanceOnRoute

Declaration

[Browsable(false)]
public float OccupyingDistanceOnRoute { get; protected set; }

Property Value

Type	Description
System.Single

Orientation

This property gets/sets the orientation of the load as a System.Numerics.Matrix4x4

Declaration

[Browsable(false)]
public virtual Matrix4x4 Orientation { get; set; }

Property Value

Type	Description
System.Numerics.Matrix4x4

Parent

This getter property is null if load is not grouped with another load, or if the load is the Parent load in case of a grouping (e.g. Group(Load), i.e. only child loads will have a value other than null

Declaration

[Browsable(false)]
public Load Parent { get; }

Property Value

Type	Description
Load

Part

The physical part of the load. This is what physics will act on for the load, in the scene.

See Dynamic for more information.

Declaration

[Browsable(false)]
public virtual IDynamic Part { get; set; }

Property Value

Type	Description
IDynamic

Path

The path is a list of strings, where the strings are the names of each ActionPoint the load will go through, on the route to its final destination, i.e. the last ActionPoint in the Path.

Declaration

[Browsable(false)]
public List<string> Path { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

PathNode

Declaration

[Browsable(false)]
public LinkedListNode<Load> PathNode { get; }

Property Value

Type	Description
System.Collections.Generic.LinkedListNode<Load>

Pitch

This getter/setter property reflects the rotation angle (in radians) of the load around the Z-axis.

Declaration

[Browsable(false)]
public virtual float Pitch { get; set; }

Property Value

Type	Description
System.Single

Position

This property returns the global 3 dimensional coordinates of the center of the load. In physics mode the position is determined by the physics engine or its movement on tracks and in discrete mode by its movement on the routes. When the load is made Kinematic or not Enabled then it makes sense to directly set the position of the load.

Declaration

[PropertyOrder(1)]
[TypeConverter(typeof(Vector3MeterToMillimeter))]
[PropertyAttributesProvider("DynamicPropertyPosition")]
public virtual Vector3 Position { get; set; }

Property Value

Type	Description
System.Numerics.Vector3

Report

When set to true the loads Statistic counter will count when a load is added and removed from Items.

Declaration

[Browsable(false)]
public bool Report { get; set; }

Property Value

Type	Description
System.Boolean

Rigid

This property uses Rigids to determine the type of PhysX.Geometry for the load's Dynamic part. If set to None the Dynamic will have no PhysX.RigidBody.

Declaration

[Browsable(false)]
public Rigids Rigid { get; set; }

Property Value

Type	Description
Rigids

Roll

This getter/setter property reflects the rotation angle (in radians) of the load around the X-axis.

Declaration

[Browsable(false)]
public virtual float Roll { get; set; }

Property Value

Type	Description
System.Single

Route

The current Route the load is on.

Declaration

[Browsable(false)]
public Route Route { get; }

Property Value

Type	Description
Route

Routed

Declaration

[Browsable(false)]
public bool Routed { get; }

Property Value

Type	Description
System.Boolean

RouteOffset

Normally a load travels on the route with the center of the load moving over the route. By using the RouteOffset property you can change this and have the center of the load moving at the given relative position from the route.

Position the load on the route with this offset. The offset is transformed with the Orientation matrix.

Declaration

[Browsable(false)]
public virtual Vector3 RouteOffset { get; set; }

Property Value

Type	Description
System.Numerics.Vector3	The route offset, the values for System.Numerics.Vector3.X, System.Numerics.Vector3.Y and System.Numerics.Vector3.Z are in meters.

RouteOffsetTransformed

Declaration

[Browsable(false)]
public Vector3 RouteOffsetTransformed { get; set; }

Property Value

Type	Description
System.Numerics.Vector3

Selectable

Indicates whether a load can be selected by the user. If you set this property to false the user will not be able to select the load.

Declaration

[Browsable(false)]
public bool Selectable { get; set; }

Property Value

Type	Description
System.Boolean

Selected

Returns true when the load is currently selected, false otherwise.

Declaration

[Browsable(false)]
public bool Selected { get; }

Property Value

Type	Description
System.Boolean

SelectedGroupLoad

Declaration

[Browsable(false)]
public ILoad SelectedGroupLoad { get; }

Property Value

Type	Description
ILoad

Selection

The currently selected load, returns null if no load is currently selected.

Declaration

public static Load Selection { get; }

Property Value

Type	Description
Load

Sleeping

Declaration

[Browsable(false)]
public bool Sleeping { get; }

Property Value

Type	Description
System.Boolean

SpeedFactor

Change the speed factor of the load, this will change how the load's velocity gets impacted by forces applied to it.

Note: this is only useable in physics mode

Declaration

[Browsable(false)]
public float SpeedFactor { get; set; }

Property Value

Type	Description
System.Single	The speed factor. 1 is the default value.

Statistic

Declaration

public static Statistics.Statistic.Counter Statistic { get; }

Property Value

Type	Description
Statistics.Statistic.Counter

Stopped

This getter property returns true when the load is currently stopped, false otherwise.

Declaration

[Browsable(false)]
public bool Stopped { get; }

Property Value

Type	Description
System.Boolean

TotalDistance

The total distance in meters this load has been moved on routes.

Declaration

[Browsable(false)]
public float TotalDistance { get; }

Property Value

Type	Description
System.Single

UserData

You can add custom data to a load by using this UserData property. E.g you can create you own TransportOrder class containing data from the WMS like PurchaseOrder, Customer, Source, Destination, DueDate,… and attach it to the load: myload.UserData = aTransportOrder;.

You can inspect the data again by casting the UserData back to the class it was given: string customer = (myload.UserData as TransportOrder).Customer;

Declaration

[PropertyOrder(0)]
[Display(Order = 0, GroupName = "User Data")]
[PropertyAttributesProvider("DynamicPropertyUserData")]
[TypeConverter(typeof(ObjectConverter))]
public virtual object UserData { get; set; }

Property Value

Type	Description
System.Object

UserDeletable

Property to indicate whether the user can delete the load (e.g.by selecting it and pressing the Delete button). If false the load can't be deleted by the user

Declaration

[Browsable(false)]
public bool UserDeletable { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [user deletable]; otherwise, `false`.

Velocity

Gets the current velocity of the load (in m/s).

Declaration

[Browsable(false)]
public Vector3 Velocity { get; }

Property Value

Type	Description
System.Numerics.Vector3

Visible

Gets or sets whether the load is visible in the scene.

Declaration

[Browsable(false)]
public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	`true` if visible.

Waiting

Shows whether the load is waiting to be able to move.

Declaration

[Browsable(false)]
public bool Waiting { get; }

Property Value

Type	Description
System.Boolean	`true` if load is stopped and waiting.

WaitingTime

Setting this property makes a load wait at its current position. The waiting time is provided in seconds. When this waiting time is elapsed the load will trigger the OnFinishedWaitingEvent and continue.

Declaration

[Browsable(false)]
public float WaitingTime { get; set; }

Property Value

Type	Description
System.Single

Weight

This represents the weight (Kg) of the load. Setting this will also calculate and set the density.

Declaration

[PropertyAttributesProvider("DynamicPropertyWeight")]
public float Weight { get; set; }

Property Value

Type	Description
System.Single

Width

Width of the load in meters.

Declaration

[Browsable(false)]
public virtual float Width { get; }

Property Value

Type	Description
System.Single

Yaw

This getter/setter property reflects the rotation angle (in radians) of the load around the Y-axis.

Declaration

[PropertyOrder(0)]
[PropertyAttributesProvider("DynamicPropertyAngle")]
[TypeConverter(typeof(RadiansToDegreesPI))]
public virtual float Yaw { get; set; }

Property Value

Type	Description
System.Single

Methods

AddForce(Vector3)

Adds a force vector to the loads Dynamic part.

Declaration

public void AddForce(Vector3 force)

Parameters

Type	Name	Description
System.Numerics.Vector3	force	The force vector to add to the Dynamic part.

AddForceAtPosition(Vector3, Vector3)

Adds a force vector to the loads Dynamic part at a given position.

Declaration

public void AddForceAtPosition(Vector3 force, Vector3 position)

Parameters

Type	Name	Description
System.Numerics.Vector3	force	The force vector to add to the Dynamic part.
System.Numerics.Vector3	position	The position of where to add the force vector on the Dynamic part.

AddTorque(Vector3)

Adds a torque vector to the loads Dynamic part.

Declaration

public void AddTorque(Vector3 torque)

Parameters

Type	Name	Description
System.Numerics.Vector3	torque	The torque vector to add to the Dynamic part.

Clone(Int32)

Creates a number of clones of the load according to the number of no.

Declaration

public Load[] Clone(int no)

Parameters

Type	Name	Description
System.Int32	no	The number of clones to be created.

Returns

Type	Description
Load[]	Returns an array of the cloned loads.

Create(LoadInfo)

Create a load using the given info.

Note: The load is added to the environment at the same time.

Declaration

public static Load Create(LoadInfo info)

Parameters

Type	Name	Description
LoadInfo	info	The info class for the load.

Returns

Type	Description
Load	The created Load.

Exceptions

Type	Condition
System.Exception	Invoking is required to create loads

Create(EmbeddedResource)

Declaration

public static Load Create(EmbeddedResource embeddedResource)

Parameters

Type	Name	Description
EmbeddedResource	embeddedResource

Returns

Type	Description
Load

Create(EmbeddedResource, Rigids)

Creates a load with the given embeddedResource as the mesh for the load. rigid determines the shape of the physically interacting Dynamic Part of the load ( Note: Can be seen while View->Debug->Level->Detailed is enabled in Experior ). NOTE: Creating loads like this is not serializable.

Declaration

public static Load Create(EmbeddedResource embeddedResource, Rigids rigid)

Parameters

Type	Name	Description
EmbeddedResource	embeddedResource	The mesh for the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(EmbeddedResource, Single, Single, Single)

Declaration

public static Load Create(EmbeddedResource embeddedResource, float length, float height, float width)

Parameters

Type	Name	Description
EmbeddedResource	embeddedResource
System.Single	length
System.Single	height
System.Single	width

Returns

Type	Description
Load

Create(EmbeddedResource, Single, Single, Single, Rigids)

Declaration

public static Load Create(EmbeddedResource embeddedResource, float length, float height, float width, Rigids rigid)

Parameters

Type	Name	Description
EmbeddedResource	embeddedResource
System.Single	length
System.Single	height
System.Single	width
Rigids	rigid

Returns

Type	Description
Load

Create(String, Rigids)

This method calls Create(String, String, Single, Single, Single, Single, Color, Rigids, String) with Create(filename, System.String.Empty, 0, 0, 0, 1, System.Windows.Media.Colors.Black, rigid, System.String.Empty).

Declaration

public static Load Create(string filename, Rigids rigid)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, Single, Single, Single, Rigids)

This method calls Create(String, String, Single, Single, Single, Single, Color, Rigids, String) with Create(filename, System.String.Empty, length, height, width, 1, System.Windows.Media.Colors.Black, rigid, System.String.Empty).

Declaration

public static Load Create(string filename, float length, float height, float width, Rigids rigid)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, Single, Single, Single, Single)

This method calls Create(String, String, Single, Single, Single, Single, Color, Rigids, String) with Create(filename, System.String.Empty, length, height, width, density, System.Windows.Media.Colors.Black, Box, System.String.Empty).

Declaration

public static Load Create(string filename, float length, float height, float width, float density)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, Single, Single, Single, Single, Rigids)

Declaration

public static Load Create(string filename, float length, float height, float width, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, Single, Single, Single, Single, Rigids, String)

Declaration

public static Load Create(string filename, float length, float height, float width, float density, Rigids rigid, string texturefile)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
Rigids	rigid	The shape of the Dynamic Part of the load.
System.String	texturefile

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, Single, Single, Single, Single, String)

Declaration

public static Load Create(string filename, float length, float height, float width, float density, string textureFile)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.String	textureFile

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, Single, Single, Single, Single, Color)

Declaration

public static Load Create(string filename, float length, float height, float width, float density, Color color)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, Single, Single, Single, Single, Color, Rigids)

Declaration

public static Load Create(string filename, float length, float height, float width, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, Single, Single, Single, Single, Color, Rigids, String)

This method calls Create(String, String, Single, Single, Single, Single, Color, Rigids, String) with Create(System.String.Empty, barcode, length, height, width, density, color, rigid, textureFile).

Declaration

public static Load Create(string barcode, float length, float height, float width, float density, Color color, Rigids rigid, string textureFile)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.
System.String	textureFile

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, Single, Single, Single, Color)

This method calls Create(String, String, Single, Single, Single, Single, Color, Rigids, String) with Create(filename, System.String.Empty, length, height, width, 1, color, Box, System.String.Empty).

Declaration

public static Load Create(string filename, float length, float height, float width, Color color)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, Single, Single, Single, Color, Rigids)

Declaration

public static Load Create(string filename, float length, float height, float width, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, String, Rigids)

This method calls Create(String, String, Single, Single, Single, Single, Color, Rigids, String) with Create(filename, barcode, 0, 0, 0, 1, System.Windows.Media.Colors.Black, rigid, System.String.Empty).

Declaration

public static Load Create(string filename, string barcode, Rigids rigid)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.String	barcode	The Identification of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, String, Single, Single, Single, Rigids)

This method calls Create(String, String, Single, Single, Single, Single, Color, Rigids, String) with Create(filename, barcode, length, height, width, 1, System.Windows.Media.Colors.Black, rigid, System.String.Empty).

Declaration

public static Load Create(string filename, string barcode, float length, float height, float width, Rigids rigid)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, String, Single, Single, Single, Single)

This method calls Create(String, String, Single, Single, Single, Single, Color, Rigids, String) with Create(filename, barcode, length, height, width, density, System.Windows.Media.Colors.Black, Box, System.String.Empty).

Declaration

public static Load Create(string filename, string barcode, float length, float height, float width, float density)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, String, Single, Single, Single, Single, Rigids)

Declaration

public static Load Create(string filename, string barcode, float length, float height, float width, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, String, Single, Single, Single, Single, Rigids, String)

Declaration

public static Load Create(string filename, string barcode, float length, float height, float width, float density, Rigids rigid, string texturefile)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
Rigids	rigid	The shape of the Dynamic Part of the load.
System.String	texturefile

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, String, Single, Single, Single, Single, String)

Declaration

public static Load Create(string filename, string barcode, float length, float height, float width, float density, string textureFile)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.String	textureFile

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, String, Single, Single, Single, Single, Color)

This method calls Create(String, String, Single, Single, Single, Single, Color, Rigids, String) with Create(filename, barcode, length, height, width, density, color, Box, System.String.Empty).

Declaration

public static Load Create(string filename, string barcode, float length, float height, float width, float density, Color color)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, String, Single, Single, Single, Single, Color, Rigids)

This method calls Create(String, String, Single, Single, Single, Single, Color, Rigids, String) with Create(filename, barcode, length, height, width, density, color, rigid, System.String.Empty).

Declaration

public static Load Create(string filename, string barcode, float length, float height, float width, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, String, Single, Single, Single, Single, Color, Rigids, String)

Creates a load with a mesh based on the given filename. The load's mesh will be created with the size given by length, height and width. rigid determines the shape of the physically interacting Dynamic Part of the load ( Note: Can be seen while View->Debug->Level->Detailed is enabled in Experior ). The color determines the determines the color of the mesh.

Note: The load is added to the environment at the same time.

Declaration

public static Load Create(string filename, string barcode, float length, float height, float width, float density, Color color, Rigids rigid, string textureFile)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.
System.String	textureFile

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, String, Single, Single, Single, Color)

This method calls Create(String, String, Single, Single, Single, Single, Color, Rigids, String) with Create(filename, barcode, length, height, width, 1, color, Box, System.String.Empty).

Declaration

public static Load Create(string filename, string barcode, float length, float height, float width, Color color)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, String, Single, Single, Single, Color, Rigids)

This method calls Create(String, String, Single, Single, Single, Single, Color, Rigids, String) with Create(filename, barcode, length, height, width, 1, color, rigid, System.String.Empty).

Declaration

public static Load Create(string filename, string barcode, float length, float height, float width, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, String, Color, Rigids)

This method calls Create(String, String, Single, Single, Single, Single, Color, Rigids, String) with Create(filename, barcode, 0, 0, 0, 1, color, rigid, string.Empty).

Declaration

public static Load Create(string filename, string barcode, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.String	barcode	The Identification of the load.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

Create(String, Color, Rigids)

This method calls Create(String, String, Single, Single, Single, Single, Color, Rigids, String) with Create(filename, System.String.Empty, 0, 0, 0, 1, color, rigid, System.String.Empty).

Declaration

public static Load Create(string filename, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	filename	The path/name of the mesh used for the load.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBag(String, Single, Single, Single, Single, Color, Rigids)

Creates a load with a bag mesh. The load's mesh will be created with the size given by length, height and width. rigid determines the shape of the physically interacting Dynamic Part of the load ( Note: Can be seen while View->Debug->Level->Detailed is enabled in Experior ). The color determines the determines the color of the mesh.

Note: The load is added to the environment at the same time.

Declaration

public static Load CreateBag(string barcode, float length, float height, float width, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBag(String, Color)

Calls CreateBag(String, Single, Single, Single, Single, Color, Rigids) with CreateBag(barcode, 1, 0, 0, 0, color, Box).

Declaration

public static Load CreateBag(string barcode, Color color)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBeerBox(Single, Single, Single, Single, Rigids)

Calls CreateBeerBox(String, Single, Single, Single, Single, Rigids) with CreateBeerBox(System.String.Empty, length, height, width, density, rigid).

Declaration

public static Load CreateBeerBox(float length, float height, float width, float density, Rigids rigid)

Parameters

Type	Name	Description
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBeerBox(String, Single, Single, Single, Single, Rigids)

Creates a load with a beer box mesh. The load's mesh will be created with the size given by length, height and width. rigid determines the shape of the physically interacting Dynamic Part of the load ( Note: Can be seen while View->Debug->Level->Detailed is enabled in Experior ).

Note: The load is added to the environment at the same time.

Declaration

public static Load CreateBeerBox(string barcode, float length, float height, float width, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBottle(String, Color)

Creates a load with a bottle mesh. The color determines the determines the color of the mesh.

Declaration

public static Load CreateBottle(string barcode, Color color)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBottle(Color)

Calls CreateBottle(String, Color) with CreateBottle(System.String.Empty, color).

Declaration

public static Load CreateBottle(Color color)

Parameters

Type	Name	Description
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBottleCrate(String, Single, Single, Single, Single, Rigids)

Declaration

public static Load CreateBottleCrate(string barcode, float length, float height, float width, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreateBox(Single, Single, Single, Single, Color)

Calls CreateBox(String, Single, Single, Single, Nullable<Single>, Color, Rigids) with CreateBox(System.String.Empty, length, height, width, density, color, Box).

Declaration

public static Load CreateBox(float length, float height, float width, float density, Color color)

Parameters

Type	Name	Description
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBox(Single, Single, Single, Single, Color, Rigids)

Calls CreateBox(String, Single, Single, Single, Nullable<Single>, Color, Rigids) with CreateBox(System.String.Empty, length, height, width, density, color, rigid).

Declaration

public static Load CreateBox(float length, float height, float width, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBox(Single, Single, Single, Color)

Calls CreateBox(String, Single, Single, Single, Nullable<Single>, Color, Rigids) with CreateBox(System.String.Empty, length, height, width, null, color, Box).

Declaration

public static Load CreateBox(float length, float height, float width, Color color)

Parameters

Type	Name	Description
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBox(Single, Single, Single, Color, Rigids)

Calls CreateBox(String, Single, Single, Single, Nullable<Single>, Color, Rigids) with CreateBox(System.String.Empty, length, height, width, null, color, rigid).

Declaration

public static Load CreateBox(float length, float height, float width, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBox(String, Single, Single, Single, Nullable<Single>, Color, Rigids)

Creates a Box load. The load will be created with the size given by length, height and width. rigid determines the shape of the physically interacting Dynamic Part of the load ( Note: Can be seen while View->Debug->Level->Detailed is enabled in Experior ). The color determines the determines the color of the load.

Note: The load is added to the environment at the same time.

Declaration

public static Load CreateBox(string barcode, float length, float height, float width, float? density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Nullable<System.Single>	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBox(String, Single, Single, Single, Single, Color)

Calls CreateBox(String, Single, Single, Single, Nullable<Single>, Color, Rigids) with CreateBox(barcode, length, height, width, density, color, Box).

Declaration

public static Load CreateBox(string barcode, float length, float height, float width, float density, Color color)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBox(String, Single, Single, Single, Single, Color, Rigids)

Calls CreateBox(String, Single, Single, Single, Nullable<Single>, Color, Rigids) with CreateBox(barcode, length, height, width, density, color, rigid).

Declaration

public static Load CreateBox(string barcode, float length, float height, float width, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBox(String, Single, Single, Single, Color)

Calls CreateBox(String, Single, Single, Single, Nullable<Single>, Color, Rigids) with CreateBox(barcode, length, height, width, null, color, Box).

Declaration

public static Load CreateBox(string barcode, float length, float height, float width, Color color)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateBox(String, Single, Single, Single, Color, Rigids)

Calls CreateBox(String, Single, Single, Single, Nullable<Single>, Color, Rigids) with CreateBox(barcode, length, height, width, null, color, rigid).

Declaration

public static Load CreateBox(string barcode, float length, float height, float width, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateCan(Single, Single, Single, Rigids)

Calls CreateCan(String, Single, Single, Single, Color, Rigids) with CreateCan(System.String.Empty, radius, height, density, System.Windows.Media.Colors.Black, rigid).

Declaration

public static Load CreateCan(float radius, float height, float density, Rigids rigid = Rigids.Convex)

Parameters

Type	Name	Description
System.Single	radius	The radius of the cylinder shaped load in meters.
System.Single	height	The Height of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateCan(Single, Single, Single, Color, Rigids)

Calls CreateCan(String, Single, Single, Single, Color, Rigids) with CreateCan(System.String.Empty, radius, height, density, color, rigid).

Declaration

public static Load CreateCan(float radius, float height, float density, Color color, Rigids rigid = Rigids.Convex)

Parameters

Type	Name	Description
System.Single	radius	The radius of the cylinder shaped load in meters.
System.Single	height	The Height of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateCan(Single, Single, Color)

Calls CreateCan(String, Single, Single, Single, Color, Rigids) with CreateCan(System.String.Empty, radius, height, 1, color, Convex).

Declaration

public static Load CreateCan(float radius, float height, Color color)

Parameters

Type	Name	Description
System.Single	radius	The radius of the cylinder shaped load in meters.
System.Single	height	The Height of the load in meters.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load

CreateCan(String, Single, Single, Single, Color, Rigids)

Creates a Can (Cylinder) load. The load will be created with the size given by radius and height. rigid determines the shape of the physically interacting Dynamic Part of the load ( Note: Can be seen while View->Debug->Level->Detailed is enabled in Experior ). The color determines the determines the color of the load.

Note: The load is added to the environment at the same time.

Declaration

public static Load CreateCan(string barcode, float radius, float height, float density, Color color, Rigids rigid = Rigids.Convex)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	radius	The radius of the cylinder shaped load in meters.
System.Single	height	The Height of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateCokeCan()

Calls CreateCokeCan(String) with CreateCokeCan(System.String.Empty).

Declaration

public static Load CreateCokeCan()

Returns

Type	Description
Load	The load created with the given parameter.

CreateCokeCan(String)

Creates a load with a coke can Mesh.

Note: The load is added to the environment at the same time.

Declaration

public static Load CreateCokeCan(string barcode)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateDispenseBox(Single, Single, Single, Single, Color, Rigids)

Calls CreateDispenseBox(String, Single, Single, Single, Single, Color, Rigids) with CreateDispenseBox(System.String.Empty, length, height, width, density, color, rigid).

Declaration

public static Load CreateDispenseBox(float length, float height, float width, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateDispenseBox(Single, Single, Single, Color)

Calls CreateDispenseBox(String, Single, Single, Single, Single, Color, Rigids) with CreateDispenseBox(System.String.Empty, length, height, width, 1, color, Box).

Declaration

public static Load CreateDispenseBox(float length, float height, float width, Color color)

Parameters

Type	Name	Description
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateDispenseBox(String, Single, Single, Single, Single, Color, Rigids)

Creates a load with a Dispense Box mesh. The load's mesh will be created with the size given by length, height and width. rigid determines the shape of the physically interacting Dynamic Part of the load ( Note: Can be seen while View->Debug->Level->Detailed is enabled in Experior ). The color determines the determines the color of the mesh.

Note: The load is added to the environment at the same time.

Declaration

public static Load CreateDispenseBox(string barcode, float length, float height, float width, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateDispenseBox(String, Single, Single, Single, Color)

Calls CreateDispenseBox(String, Single, Single, Single, Single, Color, Rigids) with CreateDispenseBox(barcode, length, height, width, 1, color, Box).

Declaration

public static Load CreateDispenseBox(string barcode, float length, float height, float width, Color color)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPallet()

Calls CreateEuroPallet(String, Single, Color, Rigids) with CreateEuroPallet(System.String.Empty, 1, System.Windows.Media.Colors.Khaki, Box).

Declaration

public static Load CreateEuroPallet()

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPallet(Single, Rigids)

Calls CreateEuroPallet(String, Single, Color, Rigids) with CreateEuroPallet(System.String.Empty, density, System.Windows.Media.Colors.Khaki, rigid).

Declaration

public static Load CreateEuroPallet(float density, Rigids rigid)

Parameters

Type	Name	Description
System.Single	density	The Density of the load in kilogram per cubic meter.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPallet(Single, Color, Rigids)

Calls CreateEuroPallet(String, Single, Color, Rigids) with CreateEuroPallet(System.String.Empty, density, color, rigid).

Declaration

public static Load CreateEuroPallet(float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPallet(String)

Calls CreateEuroPallet(String, Single, Color, Rigids) with CreateEuroPallet(barcode, 1, System.Windows.Media.Colors.Khaki, Box).

Declaration

public static Load CreateEuroPallet(string barcode)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPallet(String, Single, Rigids)

Calls CreateEuroPallet(String, Single, Color, Rigids) with CreateEuroPallet(barcode, density, System.Windows.Media.Colors.Khaki, rigid).

Declaration

public static Load CreateEuroPallet(string barcode, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	density	The Density of the load in kilogram per cubic meter.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPallet(String, Single, Color, Rigids)

Creates a load with a Euro pallet mesh. rigid determines the shape of the physically interacting Dynamic Part of the load ( Note: Can be seen while View->Debug->Level->Detailed is enabled in Experior ). The color determines the determines the color of the mesh.

Note: The load is added to the environment at the same time.

Declaration

public static Load CreateEuroPallet(string barcode, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPalletDetailed(Single, Color)

Calls CreateEuroPalletDetailed(String, Single, Color) with CreateEuroPalletDetailed(System.String.Empty, density, color).

Declaration

public static Load CreateEuroPalletDetailed(float density, Color color)

Parameters

Type	Name	Description
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPalletDetailed(String, Single, Color)

Creates a load with the shape of a Euro pallet. The color determines the determines the color of the mesh.

Note: The load is added to the environment at the same time.

Declaration

public static Load CreateEuroPalletDetailed(string barcode, float density, Color color)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPalletLoaded()

Calls CreateEuroPalletLoaded(String, Single, Color, Rigids) with CreateEuroPalletLoaded(System.String.Empty, 1, System.Windows.Media.Colors.Khaki, Box).

Declaration

public static Load CreateEuroPalletLoaded()

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPalletLoaded(Single, Rigids)

Calls CreateEuroPalletLoaded(String, Single, Color, Rigids) with CreateEuroPalletLoaded(System.String.Empty, density, System.Windows.Media.Colors.Khaki, rigid).

Declaration

public static Load CreateEuroPalletLoaded(float density, Rigids rigid)

Parameters

Type	Name	Description
System.Single	density	The Density of the load in kilogram per cubic meter.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPalletLoaded(Single, Color, Rigids)

Calls CreateEuroPalletLoaded(String, Single, Color, Rigids) with CreateEuroPalletLoaded(System.String.Empty, density, color, rigid).

Declaration

public static Load CreateEuroPalletLoaded(float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPalletLoaded(String)

Calls CreateEuroPalletLoaded(String, Single, Color, Rigids) with CreateEuroPalletLoaded(barcode, 1, System.Windows.Media.Colors.Khaki, Box).

Declaration

public static Load CreateEuroPalletLoaded(string barcode)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPalletLoaded(String, Single, Rigids)

Calls CreateEuroPalletLoaded(String, Single, Color, Rigids) with CreateEuroPalletLoaded(barcode, density, System.Windows.Media.Colors.Khaki, rigid).

Declaration

public static Load CreateEuroPalletLoaded(string barcode, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	density	The Density of the load in kilogram per cubic meter.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPalletLoaded(String, Single, UInt32, Rigids)

Calls CreateEuroPalletLoaded(String, Single, UInt32, Color, Rigids) with CreateEuroPalletLoaded(barcode, density, layers, System.Windows.Media.Colors.Khaki, rigid).

Declaration

public static Load CreateEuroPalletLoaded(string barcode, float density, uint layers, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.UInt32	layers	The amount of layers of boxes on the Euro pallet load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPalletLoaded(String, Single, UInt32, Color, Rigids)

Creates a load with a Euro pallet mesh filled with layers of boxes. The amount of layers of boxes is given by layers. rigid determines the shape of the physically interacting Dynamic Part of the load ( Note: Can be seen while View->Debug->Level->Detailed is enabled in Experior ). The color determines the determines the color of the mesh.

Note: The load is added to the environment at the same time.

Declaration

public static Load CreateEuroPalletLoaded(string barcode, float density, uint layers, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.UInt32	layers	The amount of layers of boxes on the Euro pallet load.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPalletLoaded(String, Single, Color, Rigids)

Creates a load with a Euro pallet mesh filled with layers of boxes. rigid determines the shape of the physically interacting Dynamic Part of the load ( Note: Can be seen while View->Debug->Level->Detailed is enabled in Experior ). The color determines the determines the color of the mesh.

Note: The load is added to the environment at the same time.

Declaration

public static Load CreateEuroPalletLoaded(string barcode, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPalletLoaded(String, UInt32)

Calls CreateEuroPalletLoaded(String, Single, UInt32, Color, Rigids) with CreateEuroPalletLoaded(barcode, 1, layers, System.Windows.Media.Colors.Khaki, Box).

Declaration

public static Load CreateEuroPalletLoaded(string barcode, uint layers)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.UInt32	layers	The amount of layers of boxes on the Euro pallet load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPalletLoadedSlim(String, Single, Rigids)

Calls CreateEuroPalletLoadedSlim(String, Single, Color, Rigids) with CreateEuroPalletLoadedSlim(barcode, density, System.Windows.Media.Colors.Khaki, rigid).

Declaration

public static Load CreateEuroPalletLoadedSlim(string barcode, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	density	The Density of the load in kilogram per cubic meter.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateEuroPalletLoadedSlim(String, Single, Color, Rigids)

Note: The load is added to the environment at the same time.

Declaration

public static Load CreateEuroPalletLoadedSlim(string barcode, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateFootBall(Single, Single)

Declaration

public static Load CreateFootBall(float radius, float density)

Parameters

Type	Name	Description
System.Single	radius
System.Single	density

Returns

Type	Description
Load

CreateFootBall(String, Single, Single)

Creates a load with a ball mesh. The load's mesh will be created with the size given by radius.

Note: The load is added to the environment at the same time.

Declaration

public static Load CreateFootBall(string barcode, float radius, float density)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	radius	The radius of the cylinder shaped load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateLuggageMix(String, Single, Single, Single, Single, Color, Rigids)

Generates a random number and creates a load depending on the number (options for load to be generated are: Suitcase1, Suitcase2, Suitcase3, Suitcase4, Suitcase5, Bag). The load will be created with the given parameter(s).

Declaration

public static Load CreateLuggageMix(string barcode, float length, float height, float width, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreateNewsPapers(String, Single, Single, Single, Single, Rigids)

Creates a load with a stack of news papers mesh. The load's mesh will be created with the size given by length, height and width. rigid determines the shape of the physically interacting Dynamic Part of the load ( Note: Can be seen while View->Debug->Level->Detailed is enabled in Experior ).

Note: The load is added to the environment at the same time.

Declaration

public static Load CreateNewsPapers(string barcode, float length, float height, float width, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreatePallet(String)

Calls CreatePallet(String, Single, Single, Single, Single, Color, Rigids) with CreatePallet(barcode, 0, 0, 0, 1, System.Windows.Media.Colors.Khaki, Box).

Declaration

public static Load CreatePallet(string barcode)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreatePallet(String, Single, Rigids)

Calls CreatePallet(String, Single, Single, Single, Single, Color, Rigids) with CreatePallet(barcode, 0, 0, 0, density, System.Windows.Media.Colors.Khaki, rigid).

Declaration

public static Load CreatePallet(string barcode, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	density	The Density of the load in kilogram per cubic meter.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreatePallet(String, Single, Single, Single, Single, Color, Rigids)

Creates a load with a pallet mesh. The load's mesh will be created with the size given by length, height and width. rigid determines the shape of the physically interacting Dynamic Part of the load ( Note: Can be seen while View->Debug->Level->Detailed is enabled in Experior ). The color determines the determines the color of the mesh.

Note: The load is added to the environment at the same time.

Declaration

public static Load CreatePallet(string barcode, float length, float height, float width, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode	The Identification of the load.
System.Single	length	The Length of the load in meters.
System.Single	height	The Height of the load in meters.
System.Single	width	The Width of the load in meters.
System.Single	density	The Density of the load in kilogram per cubic meter.
System.Windows.Media.Color	color	The Color of the load.
Rigids	rigid	The shape of the Dynamic Part of the load.

Returns

Type	Description
Load	The load created with the given parameter(s).

CreatePallet(String, UInt32)

Declaration

public static Load CreatePallet(string barcode, uint layers)

Parameters

Type	Name	Description
System.String	barcode
System.UInt32	layers

Returns

Type	Description
Load

CreatePalletContainer()

Declaration

public static Load CreatePalletContainer()

Returns

Type	Description
Load

CreatePalletContainer(Single, Rigids)

Declaration

public static Load CreatePalletContainer(float density, Rigids rigid)

Parameters

Type	Name	Description
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreatePalletContainer(String)

Declaration

public static Load CreatePalletContainer(string barcode)

Parameters

Type	Name	Description
System.String	barcode

Returns

Type	Description
Load

CreatePalletContainer(String, Single, Rigids)

Declaration

public static Load CreatePalletContainer(string barcode, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreatePalletContainer(String, Single, Color, Rigids)

Declaration

public static Load CreatePalletContainer(string barcode, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	density
System.Windows.Media.Color	color
Rigids	rigid

Returns

Type	Description
Load

CreatePalletLoaded(Single, Rigids)

Declaration

public static Load CreatePalletLoaded(float density, Rigids rigid)

Parameters

Type	Name	Description
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreatePalletLoaded(String)

Declaration

public static Load CreatePalletLoaded(string barcode)

Parameters

Type	Name	Description
System.String	barcode

Returns

Type	Description
Load

CreatePalletLoaded(String, Single, Rigids)

Declaration

public static Load CreatePalletLoaded(string barcode, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreatePalletLoaded(String, Single, Color, Rigids)

Declaration

public static Load CreatePalletLoaded(string barcode, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	density
System.Windows.Media.Color	color
Rigids	rigid

Returns

Type	Description
Load

CreatePalletMetalContainer()

Declaration

public static Load CreatePalletMetalContainer()

Returns

Type	Description
Load

CreatePalletMetalContainer(String)

Declaration

public static Load CreatePalletMetalContainer(string barcode)

Parameters

Type	Name	Description
System.String	barcode

Returns

Type	Description
Load

CreatePalletMetalContainer(String, Single, Rigids)

Declaration

public static Load CreatePalletMetalContainer(string barcode, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreatePalletMetalContainer(String, Single, Color, Rigids)

Declaration

public static Load CreatePalletMetalContainer(string barcode, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	density
System.Windows.Media.Color	color
Rigids	rigid

Returns

Type	Description
Load

CreatePalletSmallContainer()

Declaration

public static Load CreatePalletSmallContainer()

Returns

Type	Description
Load

CreatePalletSmallContainer(String)

Declaration

public static Load CreatePalletSmallContainer(string barcode)

Parameters

Type	Name	Description
System.String	barcode

Returns

Type	Description
Load

CreatePalletSmallContainer(String, Single, Rigids)

Declaration

public static Load CreatePalletSmallContainer(string barcode, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreatePalletSmallContainer(String, Single, Color, Rigids)

Declaration

public static Load CreatePalletSmallContainer(string barcode, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	density
System.Windows.Media.Color	color
Rigids	rigid

Returns

Type	Description
Load

CreatePlasticBox(String, Single, Single, Single, Single)

Declaration

public static Load CreatePlasticBox(string barcode, float length, float height, float width, float density)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Single	density

Returns

Type	Description
Load

CreatePlasticBox(String, Single, Single, Single, Single, Rigids)

Declaration

public static Load CreatePlasticBox(string barcode, float length, float height, float width, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreatePlasticBox(String, Single, Single, Single, Color, Single)

Declaration

public static Load CreatePlasticBox(string barcode, float length, float height, float width, Color color, float density)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Windows.Media.Color	color
System.Single	density

Returns

Type	Description
Load

CreatePlasticBox(String, Single, Single, Single, Color, Single, Rigids)

Declaration

public static Load CreatePlasticBox(string barcode, float length, float height, float width, Color color, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Windows.Media.Color	color
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreatePlasticEuroPallet()

Declaration

public static Load CreatePlasticEuroPallet()

Returns

Type	Description
Load

CreatePlasticEuroPallet(String)

Declaration

public static Load CreatePlasticEuroPallet(string barcode)

Parameters

Type	Name	Description
System.String	barcode

Returns

Type	Description
Load

CreatePlasticEuroPallet(String, Single, Rigids)

Declaration

public static Load CreatePlasticEuroPallet(string barcode, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreatePlasticEuroPallet(String, Single, Color, Rigids)

Declaration

public static Load CreatePlasticEuroPallet(string barcode, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	density
System.Windows.Media.Color	color
Rigids	rigid

Returns

Type	Description
Load

CreateSack(String, Single, Single, Single, Single, Rigids)

Declaration

public static Load CreateSack(string barcode, float length, float height, float width, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreateSuitcase1(String, Single, Single, Single, Single, Color, Rigids)

Declaration

public static Load CreateSuitcase1(string barcode, float length, float height, float width, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Single	density
System.Windows.Media.Color	color
Rigids	rigid

Returns

Type	Description
Load

CreateSuitcase1(String, Color)

Declaration

public static Load CreateSuitcase1(string barcode, Color color)

Parameters

Type	Name	Description
System.String	barcode
System.Windows.Media.Color	color

Returns

Type	Description
Load

CreateSuitcase2(String, Single, Single, Single, Single, Color, Rigids)

Declaration

public static Load CreateSuitcase2(string barcode, float length, float height, float width, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Single	density
System.Windows.Media.Color	color
Rigids	rigid

Returns

Type	Description
Load

CreateSuitcase2(String, Color)

Declaration

public static Load CreateSuitcase2(string barcode, Color color)

Parameters

Type	Name	Description
System.String	barcode
System.Windows.Media.Color	color

Returns

Type	Description
Load

CreateSuitcase3(String, Single, Single, Single, Single, Color, Rigids)

Declaration

public static Load CreateSuitcase3(string barcode, float length, float height, float width, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Single	density
System.Windows.Media.Color	color
Rigids	rigid

Returns

Type	Description
Load

CreateSuitcase3(String, Color)

Declaration

public static Load CreateSuitcase3(string barcode, Color color)

Parameters

Type	Name	Description
System.String	barcode
System.Windows.Media.Color	color

Returns

Type	Description
Load

CreateSuitcase4(String, Single, Single, Single, Single, Color, Rigids)

Declaration

public static Load CreateSuitcase4(string barcode, float length, float height, float width, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Single	density
System.Windows.Media.Color	color
Rigids	rigid

Returns

Type	Description
Load

CreateSuitcase4(String, Color)

Declaration

public static Load CreateSuitcase4(string barcode, Color color)

Parameters

Type	Name	Description
System.String	barcode
System.Windows.Media.Color	color

Returns

Type	Description
Load

CreateSuitcase5(String, Single, Single, Single, Single, Color, Rigids)

Declaration

public static Load CreateSuitcase5(string barcode, float length, float height, float width, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Single	density
System.Windows.Media.Color	color
Rigids	rigid

Returns

Type	Description
Load

CreateSuitcase5(String, Color)

Declaration

public static Load CreateSuitcase5(string barcode, Color color)

Parameters

Type	Name	Description
System.String	barcode
System.Windows.Media.Color	color

Returns

Type	Description
Load

CreateWarehouseBin(String, Single, Single, Single, Single)

Declaration

public static Load CreateWarehouseBin(string barcode, float length, float height, float width, float density)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Single	density

Returns

Type	Description
Load

CreateWarehouseBin(String, Single, Single, Single, Single, Rigids)

Declaration

public static Load CreateWarehouseBin(string barcode, float length, float height, float width, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreateWarehouseBin(String, Single, Single, Single, Single, Rigids, Nullable<Color>)

Declaration

public static Load CreateWarehouseBin(string barcode, float length, float height, float width, float density, Rigids rigid, Color? color)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Single	density
Rigids	rigid
System.Nullable<System.Windows.Media.Color>	color

Returns

Type	Description
Load

CreateWarehouseBin(String, Single, Single, Single, Color, Single)

Declaration

public static Load CreateWarehouseBin(string barcode, float length, float height, float width, Color color, float density)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Windows.Media.Color	color
System.Single	density

Returns

Type	Description
Load

CreateWarehouseBin(String, Single, Single, Single, Color, Single, Rigids)

Declaration

public static Load CreateWarehouseBin(string barcode, float length, float height, float width, Color color, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Windows.Media.Color	color
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreateWarehouseBottom(String, Single, Single, Single, Single, Color)

Declaration

public static Load CreateWarehouseBottom(string barcode, float length, float height, float width, float density, Color color)

Parameters

Type	Name	Description
System.String	barcode
System.Single	length
System.Single	height
System.Single	width
System.Single	density
System.Windows.Media.Color	color

Returns

Type	Description
Load

CreateWireCage()

Declaration

public static Load CreateWireCage()

Returns

Type	Description
Load

CreateWireCage(Single, Rigids)

Declaration

public static Load CreateWireCage(float density, Rigids rigid)

Parameters

Type	Name	Description
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreateWireCage(String)

Declaration

public static Load CreateWireCage(string barcode)

Parameters

Type	Name	Description
System.String	barcode

Returns

Type	Description
Load

CreateWireCage(String, Single, Rigids)

Declaration

public static Load CreateWireCage(string barcode, float density, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	density
Rigids	rigid

Returns

Type	Description
Load

CreateWireCage(String, Single, Color, Rigids)

Declaration

public static Load CreateWireCage(string barcode, float density, Color color, Rigids rigid)

Parameters

Type	Name	Description
System.String	barcode
System.Single	density
System.Windows.Media.Color	color
Rigids	rigid

Returns

Type	Description
Load

Delete(Load)

Declaration

public static void Delete(Load load)

Parameters

Type	Name	Description
Load	load

Delete(Load, UInt64)

Declaration

public static void Delete(Load load, ulong delay)

Parameters

Type	Name	Description
Load	load
System.UInt64	delay

DeleteAll()

Declaration

public static void DeleteAll()

Deselect()

Deselects the load. If load IsGrouped, deselects each load within the group.

Declaration

public void Deselect()

Dispose()

Called to delete the load.

Note: Will not delete the load if Deletable is set to false

Declaration

public virtual void Dispose()

DynamicPropertyAngle(PropertyAttributes)

Declaration

public virtual void DynamicPropertyAngle(PropertyAttributes attributes)

Parameters

Type	Name	Description
PropertyAttributes	attributes

DynamicPropertyUserData(PropertyAttributes)

Declaration

public void DynamicPropertyUserData(PropertyAttributes attributes)

Parameters

Type	Name	Description
PropertyAttributes	attributes

Get(String)

Declaration

public static ILoad Get(string identification)

Parameters

Type	Name	Description
System.String	identification

Returns

Type	Description
ILoad

GetLoads(Vector3, Single)

Declaration

public static ArrayList GetLoads(Vector3 center, float length)

Parameters

Type	Name	Description
System.Numerics.Vector3	center
System.Single	length

Returns

Type	Description
System.Collections.ArrayList

Group(Load)

This method calls Group(Load, Action) with load and null for parameters.

Declaration

public void Group(Load load)

Parameters

Type	Name	Description
Load	load	The load to group with.

Group(Load, Action)

This method groups this load with load, then performs the given System.Action The loads will be grouped with their current position, with the child load using its current position, relative to the parents position in the scene as its LocalPosition.

Declaration

public void Group(Load load, Action action)

Parameters

Type	Name	Description
Load	load	The load to group with.
System.Action	action	Is invoked after loads have been grouped and after OnGrouped event.

Remarks

In discrete mode the grouping of loads happens instantaneously and immediately after calling the Group methods the grouped loads are available. Due to the nature of the physics engine this is postponed until the physics engine has finished its cycle of applying forces to loads. So in physics mode the grouped load is available when the OnGrouped event is raised.

Group(Load, Vector3)

This method calls Group(Load, Vector3, Action) with load, localPosition and null for parameters.

Declaration

public void Group(Load load, Vector3 localPosition)

Parameters

Type	Name	Description
Load	load	The load to group with.
System.Numerics.Vector3	localPosition	The local position of the load to group with.

Group(Load, Vector3, Action)

This method calls Group(Load, Vector3, Matrix4x4, Action) with load, localPosition, Matrix4x4.Identity and action for parameters.

Declaration

public void Group(Load load, Vector3 localPosition, Action action)

Parameters

Type	Name	Description
Load	load	The load to group with.
System.Numerics.Vector3	localPosition	The local position of the load to group with.
System.Action	action	Is invoked after loads have been grouped and after OnGrouped event.

Group(Load, Vector3, Matrix4x4)

This method calls Group(Load, Vector3, Matrix4x4, Action) with load, localPosition, localOrientation and null for parameters.

Declaration

public void Group(Load load, Vector3 localPosition, Matrix4x4 localOrientation)

Parameters

Type	Name	Description
Load	load	The load to group with.
System.Numerics.Vector3	localPosition	The local position of the load to group with.
System.Numerics.Matrix4x4	localOrientation	The local orientation of the load to group with.

Group(Load, Vector3, Matrix4x4, Action)

This method groups this load with load, then performs the given System.Action The parent load will be grouped with its current position, and the child will be grouped with the given localPosition and localOrientation as its LocalPosition and LocalOrientation. If the given localPosition is System.Numerics.Vector3.Zero or localOrientation is System.Numerics.Matrix4x4.Identity. Then the child load will be grouped using its current position, relative to its parent's Position as its LocalPosition.

Declaration

public void Group(Load load, Vector3 localPosition, Matrix4x4 localOrientation, Action action)

Parameters

Type	Name	Description
Load	load	The load to group with.
System.Numerics.Vector3	localPosition	The local position of the load to group with.
System.Numerics.Matrix4x4	localOrientation	The local orientation of the load to group with.
System.Action	action	Is invoked after loads have been grouped and after OnGrouped event.

Remarks

Group(Load, Vector3, Single, Single, Single)

This method calls Group(Load, Vector3, Matrix4x4) with load, localPosition and creating a Matrix4x4 from localYaw / localPitch / localRoll for parameters.

Declaration

public void Group(Load load, Vector3 localPosition, float localYaw, float localPitch, float localRoll)

Parameters

Type	Name	Description
Load	load	The load to group with.
System.Numerics.Vector3	localPosition	The local position of the load to group with.
System.Single	localYaw	The local yaw of the load to group with.
System.Single	localPitch	The local pitch of the load to group with.
System.Single	localRoll	The local roll of the load to group with.

Group(List<Load>)

This method calls Group(List<Load>, Action) with loads and null for parameters.

Declaration

public void Group(List<Load> loads)

Parameters

Type	Name	Description
System.Collections.Generic.List<Load>	loads	The loads to group with.

Group(List<Load>, Action)

This method groups this load with loads. The loads will be grouped with their current position, with the child loads using their current position, relative to the parents position in the scene as its LocalPosition. The given System.Action action will be performed after each load is grouped.

Declaration

public void Group(List<Load> loads, Action action)

Parameters

Type	Name	Description
System.Collections.Generic.List<Load>	loads	The loads to group with.
System.Action	action	Is invoked after loads have been grouped and after OnGrouped event.

Remarks

Group(List<Load>, List<Vector3>, List<Matrix4x4>)

This method calls Group(List<Load>, List<Vector3>, List<Matrix4x4>, Action) with loads, positions, orientations and null for parameters.

Declaration

public void Group(List<Load> loads, List<Vector3> positions, List<Matrix4x4> orientations)

Parameters

Type	Name	Description
System.Collections.Generic.List<Load>	loads	The loads to group with.
System.Collections.Generic.List<System.Numerics.Vector3>	positions	The local positions of the loads to group with.
System.Collections.Generic.List<System.Numerics.Matrix4x4>	orientations	The local orientations of the loads to group with.

Group(List<Load>, List<Vector3>, List<Matrix4x4>, Action)

This method groups this load with loads. The parent load will be grouped with its current position and the child loads will be grouped with the given positions and orientations. If any given position of a child load is System.Numerics.Vector3.Zero or orientation is System.Numerics.Matrix4x4.Identity, then the current position, relative to the parent load, will be used as the LocalPosition for the child load. The given System.Action action will be performed after each load is grouped.

Declaration

public void Group(List<Load> loads, List<Vector3> positions, List<Matrix4x4> orientations, Action action)

Parameters

Type	Name	Description
System.Collections.Generic.List<Load>	loads	The loads to group with.
System.Collections.Generic.List<System.Numerics.Vector3>	positions	The local positions of the loads to group with.
System.Collections.Generic.List<System.Numerics.Matrix4x4>	orientations	The local orientations of the loads to group with.
System.Action	action	Is invoked after loads have been grouped and after OnGrouped event.

Remarks

HighLight(Color)

Highlights the load by changing the highlight color to the given color. This is only a temporary change. When UnHighLight() is called, it is restored to its original color (given by the Color).

Declaration

public void HighLight(Color color)

Parameters

Type	Name	Description
System.Windows.Media.Color	color	The color used to highlight the load.

KeyDown(KeyEventArgs)

Virtual method for a key down press while load is selected, has no base implementation.

Declaration

public virtual void KeyDown(KeyEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.KeyEventArgs	e	The System.Windows.Input.KeyEventArgs from the event that triggered the method.

KeyUp(KeyEventArgs)

Virtual method for key up while load is selected.

Declaration

public virtual void KeyUp(KeyEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.KeyEventArgs	e	The System.Windows.Input.KeyEventArgs from the event that triggered the method.

MoveTo(String)

This method will initiate a load traveling on its current Route to the ActionPoint with the name equal to the given destination.

If the destination ActionPoint is not reachable through routes connected to the current route then a message will be logged : ‘Can’t continue: “destination” is unreachable (“current actionpoint name“)’.

Note: Not used in physics mode.

Declaration

public virtual bool MoveTo(string destination)

Parameters

Type	Name	Description
System.String	destination	Name of the ActionPoint the load has to reach.

Returns

Type	Description
System.Boolean	Returns `false` if load cannot move to the `destination`.

MoveTo(String, String)

This method will initiate a load traveling on its current Route from the source ActionPoint to the ActionPoint with the name equal to the given destination.

Declaration

public virtual bool MoveTo(string source, string destination)

Parameters

Type	Name	Description
System.String	source	The source ActionPoint the load will travel from.
System.String	destination	Name of the ActionPoint the load has to reach.

Returns

Type	Description
System.Boolean	Returns `false` if load cannot move to the `destination`.

Pick(Vector3, Vector3)

Declaration

public PickResult Pick(Vector3 rayStart, Vector3 rayDirection)

Parameters

Type	Name	Description
System.Numerics.Vector3	rayStart
System.Numerics.Vector3	rayDirection

Returns

Type	Description
PickResult

Refresh()

Declaration

public static void Refresh()

Release()

This method will release a load that is stopped. The method will check if loads behind it should be released as well based on if the routes are Accumulating.

Then triggers the events for OnReleased, OnLoadReleased and Route.OnLoadReleased on the loads current route. Lastly it triggers ActionPoint.OnReleased on the CurrentActionPoint.

Declaration

public virtual void Release()

Release(Single)

This method will release a load that is stopped after the given delay has passed. The delay is given in seconds.

Declaration

public void Release(float delay)

Parameters

Type	Name	Description
System.Single	delay	The delay before the load is released in seconds.

Rotate(Action, Single, Single, Single, Single)

Rotate a load over a given time. If in discrete events or if on a track (in physics mode) the load will stop moving and start rotating. In physics mode it will rotate it without stopping it. When the rotating has finished a OnRotationCompleted event will occur. Note that this will set a WaitingTime for the load and throw an exception if the load is already waiting.

Declaration

public void Rotate(Action action, float time, float relativeYaw, float relativePitch, float relativeRoll)

Parameters

Type	Name	Description
System.Action	action	To execute when the rotation has completed
System.Single	time	The time it takes to rotate (seconds). The WaitingTime will be set to this value
System.Single	relativeYaw	Yaw angle to rotate (radians)
System.Single	relativePitch	Pitch angle to rotate (radians)
System.Single	relativeRoll	Roll angle to rotate (radians)

Rotate(Single, Single, Single)

Sets a load to a given yaw, pitch and/or roll in radians.

Declaration

public void Rotate(float yaw, float pitch, float roll)

Parameters

Type	Name	Description
System.Single	yaw	The yaw angle to rotate the load to.
System.Single	pitch	The pitch angle to rotate the load to.
System.Single	roll	The roll angle to rotate the load to.

Rotate(Single, Single, Single, Single)

Rotate a load on a route. The load will stop moving and start rotating. When the rotating has finished a RotationCompleted event will occur. Note that this will set a WaitingTime for the load and throw an exception if the load is already waiting.

Declaration

public void Rotate(float time, float relativeYaw, float relativePitch, float relativeRoll)

Parameters

Type	Name	Description
System.Single	time	The time it takes to rotate (seconds). The WaitingTime will be set to this value
System.Single	relativeYaw	Yaw angle to rotate (radians)
System.Single	relativePitch	Pitch angle to rotate (radians)
System.Single	relativeRoll	Roll angle to rotate (radians)

Select()

Selects the load. The properties of the load will be shown in the properties window and the load will get the SelectionColor.

Declaration

public void Select()

Sleep()

This is used in the physics mode to make the load unresponsive to the physics engine. The load will no longer respond to the forces applied to it. Note that you can WakeUp/Enable a load by clicking on it in the working area.

Declaration

public void Sleep()

Stop()

This method will stop a load on its Route/ActionPoint. The load will wait there until it is released. This will trigger the events OnStopped, OnLoadStopped.

Declaration

public virtual void Stop()

Switch(ActionPoint)

This method will put the load on the given ActionPoint ap.

Declaration

public void Switch(ActionPoint ap)

Parameters

Type	Name	Description
ActionPoint	ap	The ActionPoint to move the load to.

Switch(ActionPoint, ActionPoint.Edges)

This method will put the load on the given ActionPoint ap.

The edge argument has 3 possible values ActionPoint.Edges.Leading, ActionPoint.Edges.Trailing and the defaultActionPoint.Edges.Center.

Trailing If its value is Edges.Trailing then the load will be put on the ActionPoint ap in such a way that the position of the ActionPoint matches the trailing back of the load.
Leading If its value is Edges.Leading then the load will be put on the ActionPoint ap in such a way that the position of the ActionPoint matches the leading front of the load.

Declaration

public void Switch(ActionPoint ap, ActionPoint.Edges edge)

Parameters

Type	Name	Description
ActionPoint	ap	The ActionPoint to move the load to.
ActionPoint.Edges	edge	The edge of the ActionPoint to put the load on as determined by ActionPoint.Edges

Remarks

This assumes that there is sufficient room on the route to do the switch, meaning that the center of the load should be on the route. Suppose you have an ActionPoint at the start of a Route. In that case it is only possible to do the switch with edge Center or Trailing because using Leading implies that the center of the load would not fit on the route.

Switch(ActionPoint, Boolean)

This method will put the load on the given ActionPoint ap. When the keepGlobalOrientation argument is true then the load will keep its current global orientation (Yaw, Pitch, Roll), otherwise it will use the properties of the ActionPoint.

Declaration

public void Switch(ActionPoint ap, bool keepGlobalOrientation)

Parameters

Type	Name	Description
ActionPoint	ap	The ActionPoint to move the load to.
System.Boolean	keepGlobalOrientation	If `true` ensures the load will keep its current global orientation (Yaw, Pitch, Roll).

Switch(Route)

This method will instantaneously take the load and put it at the start of the given Route to.

Declaration

public void Switch(Route to)

Parameters

Type	Name	Description
Route	to	The Route to switch the load to.

Switch(Route, Boolean)

This method will instantaneously take the load and put it at the start of the given Route to. When the keepGlobalOrientation argument is true then the load will keep its current global orientation (Yaw, Pitch, Roll), otherwise it will use the properties of the Route.

Declaration

public void Switch(Route to, bool keepGlobalOrientation)

Parameters

Type	Name	Description
Route	to	The Route to switch the load to.
System.Boolean	keepGlobalOrientation	If `true` ensures the load will keep its current global orientation (Yaw, Pitch, Roll).

Switch(Route, Single)

This method will instantaneously take the load and put it at the given distance from the start of the given Route to.

Declaration

public void Switch(Route to, float distance)

Parameters

Type	Name	Description
Route	to	The Route to switch the load to.
System.Single	distance	The distance from the start of the Route, if distance is longer than the routes length, it's set to the routes length.

Switch(Route, Single, Boolean)

This method will instantaneously take the load and put it at the given distance from the start of the given Route to. When the keepGlobalOrientation argument is true then the load will keep its current global orientation (Yaw, Pitch, Roll), otherwise it will use the properties of the Route.

Declaration

public void Switch(Route to, float distance, bool keepGlobalOrientation)

Parameters

Type	Name	Description
Route	to	The Route to switch the load to.
System.Single	distance	The distance from the start of the Route, if distance is longer than the routes length, it's set to the routes length.
System.Boolean	keepGlobalOrientation	If `true` ensures the load will keep its current global orientation (Yaw, Pitch, Roll).

Switch(String)

This method will put the load on the ActionPoint with the given name. If no ActionPoint can be found with the given name, the call is ignored.

Declaration

public void Switch(string actionpoint)

Parameters

Type	Name	Description
System.String	actionpoint	The name of the ActionPoint to move the load to.

Switch(String, Boolean)

This method will put the load on the ActionPoint with the given name. When the keepGlobalOrientation argument is true then the load will keep its current global orientation (Yaw, Pitch, Roll), otherwise it will use the properties of the ActionPoint. If no ActionPoint can be found with the given name, the call is ignored.

Declaration

public void Switch(string actionpoint, bool keepGlobalOrientation)

Parameters

Type	Name	Description
System.String	actionpoint	The name of the ActionPoint to move the load to.
System.Boolean	keepGlobalOrientation	If `true` ensures the load will keep its current global orientation (Yaw, Pitch, Roll).

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

Translate(Action, Vector3, Single)

This method is similar to the Translate(Vector3, Single) method. Except that at the end of the translation of the load, over the given vector distance, the given action will be executed. The given System.Action is a delegate that you can use to pass a method as a parameter without explicitly declaring a custom delegate. The encapsulated method must correspond to the method signature that is defined by this delegate. This means that the encapsulated method must have no parameters and no return value.

Declaration

public Load.Translation Translate(Action action, Vector3 distance, float time)

Parameters

Type	Name	Description
System.Action	action	The action to execute after the translate has occurred
System.Numerics.Vector3	distance	The distance as a vector the load should move (x,y,z in meters)
System.Single	time	The time in seconds it takes to move the given `distance`

Returns

Type	Description
Load.Translation	A translation timer. This is equivalent to Timer.Translate, but for loads.

Translate(Vector3, Single)

This will translate a stopped load over the given distance during the given time. After the given time the load remains at its position after the translation until it is released. In case the load continues moving on a Route it will jump back to its position on the route.

Note: that the load should not be moving on a Route when calling this translate method. Otherwise you get some strange wave movement, during the given time where the load is trying to translate over the given vector, but is pulled back by it having to move on the route.

The translation used here is the load specific version of Timer.Translate

Declaration

public Load.Translation Translate(Vector3 distance, float time)

Parameters

Type	Name	Description
System.Numerics.Vector3	distance	The distance as a vector the load should move (x,y,z in meters)
System.Single	time	The time in seconds it takes to move the given `distance`

Returns

Type	Description
Load.Translation	A translation timer. This is equivalent to Timer.Translate, but for loads.

UnGroup()

This method will call UnGroup(Action) with null as parameter.

Declaration

public void UnGroup()

UnGroup(Load)

This method will call UnGroup(Load, Action) with load and null as parameters.

Declaration

public void UnGroup(Load load)

Parameters

Type	Name	Description
Load	load	The load to ungroup.

UnGroup(Load, Action)

This method will ungroup the given load from the parent load. It will perform the given action after the load is ungrouped.

Declaration

public void UnGroup(Load load, Action action)

Parameters

Type	Name	Description
Load	load	The load to ungroup.
System.Action	action	Is invoked after loads have been ungrouped and after OnUnGrouped event.

Remarks

In discrete mode the ungrouping of loads happens instantaneously and immediately after calling the UnGroup methods the ungrouped loads are available. Due to the nature of the physics engine this is postponed until the physics engine has finished its cycle of applying forces to loads. So in physics mode the ungrouped load is available when the OnUnGrouped event is raised.

UnGroup(Action)

This method will ungroup all loads grouped with the parent load. It will perform the given action after each load is ungrouped.

Declaration

public void UnGroup(Action action)

Parameters

Type	Name	Description
System.Action	action	Is invoked after loads have been ungrouped and after OnUnGrouped event.

Remarks

UnGroup(List<Load>)

This method calls UnGroup(List<Load>, Action) with loads and null as parameters.

Declaration

public void UnGroup(List<Load> loads)

Parameters

Type	Name	Description
System.Collections.Generic.List<Load>	loads	The loads to ungroup.

UnGroup(List<Load>, Action)

This method will ungroup each of the given loads from the parent load. It will perform the given action after each load is ungrouped.

Declaration

public void UnGroup(List<Load> loads, Action action)

Parameters

Type	Name	Description
System.Collections.Generic.List<Load>	loads	The loads to ungroup.
System.Action	action	Is invoked after loads have been ungrouped and after OnUnGrouped event.

Remarks

UnGroup(Int32)

This method will get the last number of loads in the list of loads grouped with the parent load, then call UnGroup(List<Load>) on those.

Declaration

public void UnGroup(int loads)

Parameters

Type	Name	Description
System.Int32	loads	The loads to ungroup.

Remarks

UnHighLight()

UnHighlights the load, as a result it will get the color back as defined by Color

Declaration

public void UnHighLight()

WakeUp()

This is used in the physics mode to “wakeup” a sleeping load and make it respond again to the physics engine. The load will again respond to the forces applied to it.

Declaration

public void WakeUp()

Events

OnAdded

Is called when a load is added to Experior.Core.Collections.LoadCollection (Items). A load is added to the collection, when added to the scene.

Declaration

public event Load.AddedEvent OnAdded

Event Type

Type	Description
Load.AddedEvent

OnAllLoadsDeleted

Called after all loads have been deleted when Experior.UI.Common.DeleteAllLoads(bool) is called.

Declaration

public static event Load.AllLoadsDeletedEvent OnAllLoadsDeleted

Event Type

Type	Description
Load.AllLoadsDeletedEvent

OnAttached

Is called when the load gets attached to a RigidPart.

Declaration

public event Load.AttachedEvent OnAttached

Event Type

Type	Description
Load.AttachedEvent

Remarks

Attaching loads is done using one of the attach methods (e.g. Attach(Load)) of the RigidPart class.

OnAwakened

Called when the loads Part is woken up.

Declaration

public event Load.AwakenedEventHandler OnAwakened

Event Type

Type	Description
Load.AwakenedEventHandler

OnBeforeAllLoadsDeleted

Is called when deleting all loads, such as when calling DeleteAll() or Reset().

Declaration

public static event Load.BeforeAllLoadsDeletedEvent OnBeforeAllLoadsDeleted

Event Type

Type	Description
Load.BeforeAllLoadsDeletedEvent

OnBeforeDisposing

Called before any load is disposed, but called after OnDisposing for the specific load.

Declaration

public static event Load.DisposeEvent OnBeforeDisposing

Event Type

Type	Description
Load.DisposeEvent

OnContact

Is called when two loads collide with each other. Event won't get called if the load that was collided with is grouped.

Declaration

public event Load.ContactEvent OnContact

Event Type

Type	Description
Load.ContactEvent

OnDestinationReached

Called when a load reaches its destination Action Point and there's no more Paths to move towards.

Declaration

public event Load.DestinationReachedEvent OnDestinationReached

Event Type

Type	Description
Load.DestinationReachedEvent

OnDisposed

This event is called when the load is completely disposed (deleted).

Declaration

public event Load.DisposeEvent OnDisposed

Event Type

Type	Description
Load.DisposeEvent

OnDisposing

This event is called when beginning to dispose a load.

Declaration

public event Load.DisposeEvent OnDisposing

Event Type

Type	Description
Load.DisposeEvent

OnDisposingCompleted

Called after any load is disposed, but called after OnDisposed for the specific load.

Declaration

public static event Load.DisposeEvent OnDisposingCompleted

Event Type

Type	Description
Load.DisposeEvent

OnDoubleClicked

Called after any load has been double clicked.

Declaration

public static event Load.DoubleClickEvent OnDoubleClicked

Event Type

Type	Description
Load.DoubleClickEvent

OnEnabled

Called when Enabled is set to true.

Note: Won't get called if Enabled is already set to true, there's no RigidPart on the load or load has been disposed.

Declaration

public event Load.EnabledEvent OnEnabled

Event Type

Type	Description
Load.EnabledEvent

OnEnter

Called when a load is entering an Action Point.

Note: The event is called after the Controller has been called.

Declaration

public event Load.EnterEvent OnEnter

Event Type

Type	Description
Load.EnterEvent

OnFinishedWaitingEvent

Called when Waiting is true and WaitingTime is 0.

Note: Called after release of the load and is not called while updating world (event is queued and called after updating world).

Declaration

public event Load.FinishedWaiting OnFinishedWaitingEvent

Event Type

Type	Description
Load.FinishedWaiting

OnGrouped

Called when the load has been grouped. When grouping multiple loads this will get called for each load.

Declaration

public event Load.GroupedEvent OnGrouped

Event Type

Type	Description
Load.GroupedEvent

OnIdentificationChanged

Called when Identification is set.

Declaration

public event Load.IdentificationChangedEvent OnIdentificationChanged

Event Type

Type	Description
Load.IdentificationChangedEvent

OnLoadReleased

Called after any load is released, but called after OnReleased for the specific load.

Declaration

public static event Load.ReleasedEvent OnLoadReleased

Event Type

Type	Description
Load.ReleasedEvent

OnLoadStopped

Called after any load is stopped, but called after OnStopped for the specific load.

Declaration

public static event Load.ReleasedEvent OnLoadStopped

Event Type

Type	Description
Load.ReleasedEvent

OnOrientationChanged

Called when load has its rotation changed and when it's finished rotating.

Declaration

public event Load.OrientationChangedEvent OnOrientationChanged

Event Type

Type	Description
Load.OrientationChangedEvent

OnPathUpdated

Called when Path is set.

Declaration

public event Load.PathUpdatedEvent OnPathUpdated

Event Type

Type	Description
Load.PathUpdatedEvent

OnPositionChanged

Called when load has its position changed.

Declaration

public event Load.PositionChangedEvent OnPositionChanged

Event Type

Type	Description
Load.PositionChangedEvent

OnReleased

Called when Release() is called.

Declaration

public event Load.ReleasedEvent OnReleased

Event Type

Type	Description
Load.ReleasedEvent

OnRotationCompleted

Called when the load has finished rotating.

Declaration

public event Load.RotationCompletedEvent OnRotationCompleted

Event Type

Type	Description
Load.RotationCompletedEvent

OnRouteChange

Is called before the load is moved from one route to another. Note that is also the case when the load is removed without being inserted to another route. BUT be careful this is not synchronized with the discrete event execution

Declaration

public event Load.RouteChangeEvent OnRouteChange

Event Type

Type	Description
Load.RouteChangeEvent

OnRouteChanged

Is called when the load is moved from one route to another. Note that is also the case when the load is removed without being inserted to another route. BUT be careful this is not synchronized with the discrete event execution

Declaration

public event Load.RouteChangeEvent OnRouteChanged

Event Type

Type	Description
Load.RouteChangeEvent

OnSelecting

Called when the load is selected.

Declaration

public event Load.SelectingEvent OnSelecting

Event Type

Type	Description
Load.SelectingEvent

OnStopped

Called when Stop() is called.

Declaration

public event Load.ReleasedEvent OnStopped

Event Type

Type	Description
Load.ReleasedEvent

OnUnAttached

Is called when the load gets unattached to the RigidPart it was attached to.

Declaration

public event Load.AttachedEvent OnUnAttached

Event Type

Type	Description
Load.AttachedEvent

Remarks

Attaching loads is done using one of the attach methods (e.g. UnAttach()) of the RigidPart class.

OnUnGrouped

Called when ungrouping loads. (e.g UnGroup())

Declaration

public event Load.UnGroupedEvent OnUnGrouped

Event Type

Type	Description
Load.UnGroupedEvent

OnUserDisposing

The disposing process is not completed if System.ComponentModel.CancelEventArgs.Cancel is set to true. The event is only called when a user is deleting the load.

Note: By calling Dispose() directly this event will not be invoked.

Declaration

public event Load.UserDisposeEvent OnUserDisposing

Event Type

Type	Description
Load.UserDisposeEvent

OnWaked

Obsolete. Please use OnAwakened

Declaration

[Obsolete("Please use OnAwakened event.")]
public event Load.WakedEvent OnWaked

Event Type

Type	Description
Load.WakedEvent

Implements

ILoad

System.IDisposable

ILabel