PhotoEye Class

Initializes a new instance of the PhotoEye class

Returns all the aspects for this Visual.

Gets all connectors.

When true, allows scripting to wait for the OnMoved event. This is false by default to avoid performance degradation for visuals that move frequently. <p> Example scripting: <pre> sender.AllowWaitOnMove = true; Wait( sender.OnMoved ); </pre>

Return all ancestor visuals above this point in the Visual hierarchy.

The current angular velocity of the Visual in radians/second.

Determine if any animations are currently in progress for this Visual.

The global application object.

When attaching to a conveyor snap with the X axis align Forwards, Reverse or Nearest where Nearest means snap either way favoring the current relative orientation of the sensor.

The angle of the beam on the conveyor. This is in the range +/-75 degrees, with 0 being perpendicular to the direction of the conveyor.

The height of the photo eye beam above the top of roller or belt.

The length of the photo eye beam.

The horizontal length of the photo eye beam, across the parent conveyor.

If true, then the visual will always face the camera. This is useful for text that should always face the user, for example. <p> Note that the visual's Rotation property will be set automatically, and so will overwrite any updates made from scripting or from the property grid.

The catalog order code of the component as it appears in the bill of materials, e.g. "'XYZ-203-37.TZ1'". If this is blank there will be no entry in the bill of materials for this component.

The cost of the component as it appears in the bill of materials, e.g. "1595.95".

The description of the component as it appears in the bill of materials, e.g. "Driven Roller Module". If this is blank there will be no entry in the bill of materials for this component.

The color of the beam when it is blocked.

The time the sensor was last blocked.

Occurs if the sensor is still blocked after this number of seconds. If 0 then the event is never fired.

The first load to block the sensor.

The list of loads that are blocking the sensor. This will only contain more than one load if SenseMultipleLoads is true and multiple loads are blocking the sensor.

Get the bounding box of this visual including all its children.

Get the bounding sphere of this visual, including its children.

The color of the box on the side of the conveyor that the beam comes out from and goes to.

Shows whether this object casts a shadow or not. Useful for large objects such as warehouses where the walls shouldn't cast shadows on the conveyors.

Return the collection of child Visuals.

The BeamAngle clamped to +/- MaxBeamAngle degrees.

The color of the beam when it is not blocked.

The time the sensor was last cleared.

The OnClearedTimeout occurs if the sensor is still cleared after this number of seconds and is not blocked again. If 0 then the event is never fired.

The diffuse color of the first mesh material on the mesh object.

The diffuse colors of the all the mesh materials on the mesh object.

A list of visual Types that are allowed to connect to this visual. If empty, then all visuals are allowed to connect, provided they are not specified in the ConnectDisallowed list, and that the connector-specific rules also allow the connection. <p> See also: <ul> <li>Demo3D.Visuals.Visual.ConnectDisallowed <li>Demo3D.Visuals.Connector.Allowed <li>Demo3D.Visuals.Connector.Disallowed </ul>

A list of visual Types that are not allowed to connect to this visual. If a Type appears in both ConnectAllowed and ConnectDisallowed, then ConnectDisallowed takes priority and the connection is not allowed. <p> See also: <ul> <li>Demo3D.Visuals.Visual.ConnectAllowed <li>Demo3D.Visuals.Connector.Allowed <li>Demo3D.Visuals.Connector.Disallowed </ul>

All pairs of connectors from this visual.

A white list of control points that should be shown and editable.

A black list of control points that should be hidden and not editable.

(Inherited from MeshObject.)

The current destination for this visual (usually a load). This can be used by equipment to decide which direction to transfer a load, or it can be ignored. It is specific to the equipment processing the load.

The Visual that the load is current at waiting to be ordered. Any Visual can be a Station but LoadCreatorVisual the first station set when calling LoadCreatorVisual.OrderLoad(). This is normally set for loads.

Information about the current transfer in progress for this visual using the Transfer Protocol. This is normally set for loads.

The collection of CustomProperty objects for this Visual.

Return all visuals below this point in the Visual hierarchy .

Return all visuals below this point in the Visual hierarchy .

A description of the Visual.

The color of the beam when it is not enabled to sense loads.

The document that this Visual belongs to.

Whether the visual be dragged using the mouse.

Number of triangular faces in the mesh

Number of faces in Mesh for Visual and all its children.

The first child visual of this visual, or null if this visual has no children.

For a load or vehicle this will create a fixed joint between it and its parent unless there is another joint in the way. This should be true for creating composite loads or vehicles or false where there is just a logical connection to the parent, e.g. boxes in a tote.

The full name of this Visual, including the names of all Parent Visual separated by '.' characters.

Determine if this Visual has any children or not.

Determine if this Visual has any siblings or not.

(Inherited from Visual.)

A unique identifier for this Visual.

When right clicking on the object should child objects menu items be included. Default is false.

The InitialLocation of the Visual in meters from the Origin of the Parent Visual.

The InitialLocation and InitialRotation in Matrix form.

The parent that should be assigned upon reset. This is useful for vehicle-type components that should reset their position to a particular track section, for example. Note this is only applied if InitialPositionOnReset is set to True.

Moves the visual back to its initial location and rotation when Reset is pressed.

The InitialRotation of the Visual in degrees relative to the Rotation of Parent Visual.

The InitialRotation in Matrix form.

The InitialRotation of the Visual in radians relative to the Rotation of Parent Visual.

The InitialLocation of this Visual and all its Parent Visuals in Matrix form.

The InitialLocation and InitialRotation of this Visual and all its Parent Visuals in Matrix form.

Is this visual a floor visual.

Can this visual change its Location/Rotation relative to its parent at runtime. This is used to improve simulation and graphical performance by analyzing what can and can't move during a model run.

Whether this visual and all its ancestor visuals are Static.

Whether the visual's body is kinematic.

The layer for this object. If (As Parent) it inherits its layer from its parent, which may in turn inherit the layer from its parent, etc.

The visual's X, Y, and Z coordinates relative to its parent.

The visual's X coordinate relative to its parent.

The visual's Y coordinate relative to its parent.

The visual's Z coordinate relative to its parent.

The current matrix transform of the Visual local to its Parent Visual.

Bounding box used for Simulation collision calculations. Only use beam, not side bars or load stops too soon/late.

If True, then MoveTo, TurnTo will issue events that indicate when the visual has started accelerating, cruising, decelerating and has stopped. <p> When enabled, the events are issued as OnAnimatorEvent. <p>An example function that will handle these events is: <pre> function Box_OnAnimatorEvent( sender : Visual, args : AnimatorEventArgs ) { switch (args.EventType) { case AnimatorEventType.Accelerate: print("Accelerating"); break; case AnimatorEventType.Cruise: print("Cruising"); break; case AnimatorEventType.Decelerate: print("Decelerating"); break; case AnimatorEventType.Stop: print("Stopped"); break; } } </pre>

The name of the Visual.

The native C# scripting class instance for this visual

The namespace and class name to instantiate for this Visual, e.g. Demo3D.Components.Component (in this case Demo3D.Components.dll will be loaded to try to find the class)

The string used to format the new name of this component if it is copied or added to the project from a catalog. The variable name "ID" will generate a unique number for that type of component in the current project.

The next sibling of this visual, or null if this visual has no siblings.

Occurs after a property of the parent visual is updated.

Occurs after a property of the visual is updated.

Occurs after a property of a visual that has this visual in its PropertyUpdatedSubscribers list is updated.

Occurs when an animator completes.

Occurs when the visual starts to accelerate, cruise, decelerate and stop during a MoveTo or TurnTo command. Note that this event will only be issued if MoveToEventsEnabled is set to True.

Occurs when the sensor is attached to a conveyor.

Occurs before a property of the parent visual is updated.

Occurs before a property of the visual is updated.

Occurs when the sensor is blocked.

Occurs when the sensor has been blocked for BlockedTimeout seconds.

Occurs when a child is parented to this visual after the reparenting has been performed.

Occurs when a child is unparented from this visual after the reparenting has been performed.

Occurs when the sensor is cleared.

Occurs when the sensor has been cleared for ClearedTimeout seconds.

Occurs when the visual is clicked on in demonstration/navigation mode.

Occurs when this visual is connected to another visual

Occurs after a custom property of the visual is renamed.

Occurs after a custom property of the visual is updated.

Occurs when the sensor is detached from a conveyor.

Occurs when this visual is disconnected from another visual

Occurs when a visual has finished being dragged to a new location.

Occurs when a visual is about to be dragged to a new location.

Occurs at the end of each experiment. This allows finalization of any data collection, for example.

Occurs at the before each experiment starts running but after the current experiment row variables have been set. This allows initialization of the model to be done before OnInitialize has been called.

Occurs at the start of each experiment. This allows for initialization of any data collection, for example.

Occurs when Export is called from the Tag Browser. This allows custom information to be written about each tag in addition to the default data.

Occurs when Play is pressed at time 0.

Occurs when a key is pressed or released and this visual is selected.

Occurs when a key is pressed and this visual is selected.

Occurs when the document is loaded.

Occurs when a message is sent from another visual's MessageListeners list.

Occurs when the mouse moves away from the visual.

Occurs when the mouse moves over the visual.

Occurs when the mouse enters the visual.

Occurs when a mouse button is released after being pressed on the visual.

Occurs when a visual has moved or rotated. NOTE: For fast moving objects like loads this can be a performance hit.

Occurs when a MoveTo or TurnTo has finished.

Occurs when a parent or parent's parent, etc. has moved or rotated. NOTE: For fast moving objects like loads this can be a performance hit.

Occurs when the parent for the visual changes.

Occurs before OnInitialize is called. The OnPreInitialize is called for every visual in one pass. Then a second pass calls OnInitialize for every visual.

Occurs whenever the render status of a visual type is changed. This is usually in response to the user pressing one of the "Show X" buttons on the toolbar; for example, "Show Lights", "Show Support Stands", etc.

Occurs when Reset is pressed.

(Inherited from Visual.)

Occurs when the status of the "Show Direction Arrows" configuration is changed.

Occurs when the document is unloaded

Occurs when this visual is added to the model. The scene's "OnVisualAdded" is also called for each visual that is added.

Occurs when this visual is removed from the model. The scene's "OnVisualRemoved" script is also called whenever any visual is removed.

How far the sensor overhangs the sides of the conveyor. A value of 0 aligns the sensor to the exact width of the conveyor.

The parent Visual for this Visual.

The default collision margin for physics collision geometry belonging to the visual's PhysicsBody.

Whether the physics for the visual is enabled or not.

The distance of the sensor from the start of the attached conveyor. This value can be an expression, for example: (Attached.Length-0.25) will make sure that the sensor is always 0.25 from the end of the conveyor. Another example: Fixed(0.1) will make sure that the sensor is always 0.1 from the start of the conveyor.

Visuals that will be notified when any custom property on this visual is updated. Each visual will be notified via its "OnAfterSubscribedPropertyUpdated" script. <p> See also: <ul> <li>OnAfterSubscribedPropertyUpdated </ul>

The rotation of the Visual (in degrees) relative to ts Parent Visual.

The rotation of this Visual relative to its Parent in Matrix form.

The rotation of the Visual (in radians) relative to its Parent Visual.

The X rotation of the Visual (in degrees) relative to its Parent Visual.

The X rotation of the Visual (in radians) relative to its Parent Visual.

The Y rotation of the Visual (in degrees) relative to its Parent Visual.

The Y rotation of the Visual (in radians) relative to its Parent Visual.

The Z rotation of the Visual (in degrees) relative to its Parent Visual.

The Z rotation of the Visual (in radians) relative to its Parent Visual.

If this component is clicked on or is included in a selection rectangle then the parent is selected instead and its properties are shown instead. Once this is set the properties can only be changed from the Project Explorer Window.

If false then OnBlocked is called once for the first load that blocks the sensor and subsequent blocks are ignored. Also OnCleared is only called when the last load clears the sensor. If true then OnBlocked and OnCleared (including Timeouts) are called for each individual load.

Enter a non-empty name for each property that should be shown in the Simple Properties view.

Surface area of shape - for certain shapes (e.g. box, sphere, cylinder) this is overridden and it is accurate Otherwise it is the surface area of the triangular faces in the mesh. This requires a "closed" mesh, that the mesh does not have both front and back faces, and any overlap in the mesh will be counted multiple times.

Surface area of Visual and all its children.

List of names that can be used to provide multiple categories of components in a catalog. The catalog can show only components with tag "Pallets", for example.

The format string for the tooltip that appears for an object.

Get the top level visual, the one which has no parent.

The current state of transfers in or out of this visual using the Transfer Protocol. This is normally set for transfer enabled equipment (not loads).

Whether this visual supports the Transfer Protocol. This is normally set for transfer enabled equipment (not loads).

A type string for the Visual.

A string that can be used to store any custom data about the visual. This is passed to the WebGL and VR renderers to be used in remote applications.

A dictionary of user key value pairs that can be used to store any custom data about the visual.

The current linear velocity of the Visual in meters/second.

Number of vertices in the mesh

Number of vertices in Mesh for Visual and all its children.

Indicates if the built-in visual is drawn. If not visible, the component will still operate as normal, allowing it to be grouped with an imported graphic for custom component types.

The object becomes visible when it's center is this distance from the camera or greater. The default is 0. Useful for level of detail control.

The object becomes invisible when it's center is this distance from the camera or greater. The default is Infinity. Useful for level of detail control, such as hiding small objects like bolts when they get far from the camera.

Return all ancestor visuals above this point in the Visual hierarchy, including the Visual itself.

Return all visuals below this point in the Visual hierarchy including the Visual itself.

Volume of material in shape - for certain shapes (e.g. box, sphere, cylinder) this is overridden and it is accurate Otherwise it is the volume enclosed by the triangular faces in the mesh. This requires a "closed" mesh, that the mesh does not have both front and back faces, and any overlap in the mesh will be counted multiple times.

Volume of Visual and all its children.

The world axis aligned bounding box of this Visual including the bounding boxes of all the child visuals and their children.

The world axis aligned bounding box of this Visual only (excluding any children).

Get the bounding sphere of this visual, including its children, in world space relative to the Scene.

Get the bounding sphere of this visual, excluding its children, in world space relative to the Scene.

The visual's world X, Y, and Z coordinates relative to the Scene.

The visual's world X coordinate relative to the Scene.

The visual's world Y coordinate relative to the Scene.

The visual's world Z coordinate relative to the Scene.

The Location and Rotation of this Visual in Matrix form.

The world rotation of the Visual (in degrees) relative to the Scene.

The rotation of this Visual relative to the Scene in Matrix form.

The world rotation of the Visual (in radians) relative to the Scene.

The world X rotation of the Visual (in degrees) relative to the Scene.

The world X rotation of the Visual (in radians) relative to the Scene.

The world Y rotation of the Visual (in degrees) relative to the Scene.

The world Y rotation of the Visual (in radians) relative to the Scene.

The world Z rotation of the Visual (in degrees) relative to the Scene.

The world Z rotation of the Visual (in radians) relative to the Scene.

The world X-Axis for the visual

The world Y-Axis for the visual

The world Z-Axis for the visual

Add an aspect instance.

Add a custom property to the visual. If the custom property already exists, then this call will update its value and description.

Add a custom property to the visual. If the custom property already exists, then this call will update its value, type and description.

Note: For most uses, AddCustomProperty(String, Object, String) or AddSimpleProperty(String, Object, String) is more suitable, because there is no need to pass the type parameter; it is taken automatically from the value. The only exception is if the value passed in is null, since we can't extract the type.

Add a custom property and also add a PropertyAlias for that new customer property making it appear as a Simple Property.

Add a custom property and also add a PropertyAlias for that new customer property making it appear as a Simple Property.

Create a temporary custom property that won't persistent on disk when saved. The property will also be hidden in the user interface.

Create a temporary custom property that won't persistent on disk when saved. The property will also be hidden in the user interface.

Create a temporary custom property that won't persistent on disk when saved. The property will also be hidden in the user interface.

Create a temporary custom property that won't persistent on disk when saved. The property will also be hidden in the user interface.

Align the mesh bounding box of the Visual to the default FloorVisual of the Scene.

Align the mesh bounding box of the Visual to the specified FloorVisual. Pass 'null' or the SceneVisual to align to the default FloorVisual of the Scene.

Cancel any animations that are currently in progress.

Return a List<Visual> representing all the children of this visual

Create a copy of a visual and its children placed in the top level scene.

Find the visual that is attached to the supplied connectorName.

Connect the visual to another visual with the corresponding connector names. This connection replaces any existing connections on this or the other visual's connector.

Connect the visual to another visual with the corresponding connector names. This connection replaces any existing connections on this or the other visual's connector, unless allowMultiple is true, in which case this connection is added to existing connections.

Is the visual contained by the visual tree from this point down?

Is the child a direct child of the visual.

DEPRECATED: USE HasCustomProperty(String) INSTEAD.

Determines whether a custom property has been defined or not.

Delete this visual. If it is in a Document, it is removed from the document as well.

Disconnect any connections on the supplied connector name.

Changes the color over a given time. This method blocks the current script until the transition is complete.

Animate the primary color of a visual and all its descendants in a given time.

Changes the set of material colors over a given time. This method blocks the current script until the transition is complete.

Change the transparency over a given time period. Note that this may have no effect if the visual has a texture in its material.

Animate the transparency of a visual and all its descendants in a given time.

Return the collection of child Visuals that match the given predicate.

Return all visuals below this point in the Visual hierarchy that match the given predicate.

Find the first aspect of type T on one of the visuals ancestors (parent, grand-parent, etc.).

Finds all aspects of type T on any of this visual's ancestors.

Finds and returns an aspect of a given type.

Finds and returns an aspect of a given type.

Find all aspects that can be cast to the given type.

Look through children and their children to find the first visual of a given name. Breadth first search.

Find a named connector on a conveyor object, e.g. "Start"

Finds an aspect if it exists or Adds a new one if it doesn't exist.

Finds an aspect if it exists or adds a new one if it doesn't exist.

Find or create a connector of the supplied name.

Find a custom property by name if it exists. Otherwise return null.

Like FindType except it return the first instance of that type.

Look through children to find a named visual.

Look through children to find all immediate children with a given name.

Find all the objects in the Children of type Type (immediate children only)

Find all the objects in the Children of type Type (immediate children only)

Go back up through the parents of visuals to find a particular parent that matches the supplied predicate.

Go back up through the parents of visuals to find a particular parent type.

Find all the objects in the Descendants of type Type (all descendants)

Find all the objects in the Descendants of type Type (all descendants)

Find the first aspect of type T on this visual or one of its ancestors (parents, grand-parents, etc.).

Finds all aspects of type T on this visual or its ancestors.

Find the first aspect of type T on this visual or one of its descendents (children recursively)

Find all aspects of type T on this visual or one of its descendents (children recursively)

Find all the visuals that have their Type field set to 'type'.

Hold the load in one position by making it kinematic.

Get the container class for a custom property, or null if it doesn't exist.

Get the value of a custom property, or null if it doesn't exist.

Get the value of a custom property, or a defaultValue if it doesn't exist.

Set the Location and Rotation of the Visual to be the same as the InitialLocation and InitialRotation.

Set the Rotation of the Visual to be the same as the InitialRotation. The Location remains unchanged.

Returns whether an aspect of a given type can be found on the visual.

Determines whether a custom property has been defined or not.

Is this Visual a parent, grandparent, great grandparent etc. of the potentialChild.

Determine if the Visual been deleted.

(Inherited from Visual.)

Move to a new matrix location instantly.

Move to a new location instantly.

Move to a new matrix location using a speed profile.

Move to a new matrix location at a given speed.

Move to a new location given a speed profile.

Move to a new location given a speed.

Move to a new matrix location at a given speed and acceleration.

Move to a new location given a speed and acceleration.

Move to a new matrix location relative to another visual.

Move to a new matrix location relative to another visual.

Move to a new location relative to another visual.

Move to a new location relative to another visual.

Move to a new matrix location at a given speed, acceleration and deceleration.

Move to a new location given a speed, acceleration, and deceleration.

Move to a new matrix location relative to another visual.

Move to a new location relative to another visual.

Move to a new matrix location relative to another visual.

Move to a new location relative to another visual.

Move to the InitialPosition and InitialRotation.

Pop a routing target from the current routing target stack, making the next target down the stack the new current routing target. Remove this visual from the previous target's custom property called "RoutingTargetAllocators".

Push a new routing target onto the stack of routing targets, making this the new current routing target. Add this visual to a custom property on the target called "RoutingTargetAllocators". This is normally called for loads.

Attach or detach connectors and accessories to or from valid connections on this visual and all children.

Removes an aspect of a given type.

Removes an aspect.

Removes an aspect instance.

Remove a connector with a certain name.

Remove a custom property from the Visual.

Remove this visual from the current parent's list of children (if current parent is not null), and add it to the new parent's list of children (if new parent is not null). The visual's matrix is adjusted accordingly, such that its top-level world location and orientation is preserved.

Set the visual rotating.

Set the visual rotating.

Set the visual rotating.

Set the visual rotating.

Set the visual rotating.

Rotate immediately around a given local axis to a given angle relative to the visual's initial position.

Rotate around the local X axis a given amount at a given speed.

Rotate around the local Y axis a given amount at a given speed.

Rotate around the local Z axis a given amount at a given speed.

Set the value of a custom property or do nothing if it doesn't exist.

Set InitialLocation to be the current Location and InitialRotation to be the current Rotation.

Set the IsStatic property for this Visual and all children recursively.

Set the native C# scripting class instance for this visual

Atomically set the Script and NativeTypeName together but only create the NativeObject once.

Indicates that this Visual should now be in control of simulating the supplied load.

Reparents this visual to a specified parents and disables physics. This is intended for use with loads, where parent is generally a vehicle or some visual that will be moving the load.

Reparents this visual to a specified parents and sets visual to be kinematic This is intended for use with loads, where parent is generally a vehicle or some visual that will be moving the load.

Convert a visual to a stream containing XML. Use Document.CreateVisual to turn it back into a copy of the original visual.

Convert a visual to XML. Use Document.CreateVisual to turn it back into a copy of the original visual.

Transform a world coordinate to a local coordinate

Transform a world normal to a local normal

Transform a world rotation (in degrees) to a local rotation (in degrees).

Transform a world rotation (in radians) to a local rotation (in radians).

Transform a local coordinate to coordinate local to parent.

Transform a local normal to normal local to parent

Transform a local coordinate to a world coordinate.

Transform a local normal to a world normal.

Transform a local rotation (in radians) to a world rotation (in radians).

Transform a local rotation (in radians) to a world rotation (in radians).

Instantly move the visual along its local X axis by xOffset units

Move the visual along its local X axis by xOffset units, at the given speed.

Move the visual along its local X axis by xOffset units, at the given speed and acceleration

Instantly move the visual along its local Y axis by yOffset units

Move the visual along its local Y axis by yOffset units, at the given speed.

Move the visual along its local Y axis by yOffset units, at the given speed and acceleration

Instantly move the visual along its local Z axis by zOffset units

Move the visual along its local Z axis by zOffset units, at the given speed.

Move the visual along its local Z axis by zOffset units, at the given speed and acceleration

Instantly move the visual along the model's X axis by xOffset units

Move the visual along the model's X axis by xOffset units, at the given speed.

Move the visual along the model's X axis by xOffset units, at the given speed and acceleration

Instantly move the visual along the model's Y axis by yOffset units

Move the visual along the model's Y axis by yOffset units, at the given speed.

Move the visual along the model's Y axis by yOffset units, at the given speed and acceleration.

Instantly move the visual along the model's Z axis by zOffset units

Move the visual along the model's Z axis by zOffset units, at the given speed.

Move the visual along the model's Z axis by zOffset units, at the given speed and acceleration.

Immediate Matrix TurnTo

Turn to a new yaw pitch roll instantly.

Main Matrix TurnTo method

Matrix TurnTo method

Turn to a new yaw pitch roll in a fixed time.

Turns to a target rotation.

Turns to a target rotation.

Matrix TurnTo method

Main Matrix TurnTo method

Matrix TurnTo method

Turns to a target rotation.

Turns to a target rotation.

Matrix TurnTo method

Turns to a target rotation.

Turns to a target rotation.

Matrix TurnTo method

Turns to a target rotation.

Turns to a target rotation.

Turns to a target rotation.

Matrix TurnTo method

Turns to a target rotation.

Release the load in one position by making it dynamic.

Reparents this (stuck) visual to the scene and restores its physics state.

Wake up any surrounding loads that might have been disabled so they don't remain in midair.

Raised when an aspect is removed from this Visual.

Occurs when a ControlPoint drag operation is completed.

Occurs when a ControlPoint drag operation is started.

Occurs when the visual is deleted (Delete).

Occurs when the visual is initialized (OnInitialize).

Occurs when the mesh of the visual is changed.

Occurs when the visual is reset (OnReset).