Click or drag to resize

Demo3D.Visuals Namespace

The Demo3D.Visuals namespace contains functionality for creating and manipulating all visuals in the 3D scene.
Classes
  ClassDescription
Public classAngle3Property
Angle property where the yaw pitch roll angles are stored in degrees.
Public classAngularSpeedProfile
Public classAutoAttribute
Attribute used in C# Scripting to indicate that a property, field or method should be auto wired on initialize. Also used on classes to automatically set the NativeTypeName field.
Public classAxisControlPointProperties
Public classBackDynamicConnector
Public classBarrierVisual
Summary description for BarrierVisual.
Public classBBox
Store the bounding box of a mesh and expose center and radius of a bounding sphere.
Public classBindableItem
Base class for any bindable item. Most common are the CustomProperties, but also specialised bindable properties such as Conveyor.IsMotorOn or PhotoEye.IsBlocked, etc.
Public classBindableVisualPropertyReference
A visual property reference that only allows bindable items to be referenced. Bindable items are properties that can be bound to the TagBrowser. Most common are the CustomProperties, but also specialised bindable properties such as Conveyor.IsMotorOn or PhotoEye.IsBlocked, etc.
Public classBinLocation
Attached as a custom property to loads that are parented to a shelf or are about to be parented to a shelf.
Public classBinProperties
Properties of an individual bin/slot within a bay on a shelf. Loads within bins can be positioned in all three dimensions.
Public classBoxTubeCorner
The properties for the corner of a box tube.
Public classBoxTubeEnd
The properties for the end of a box tube.
Public classBoxTubeVisual
Extruded box visual.
Public classBoxVisual
The physics primitive type to use for the box visual.
Public classBREPEntitySerializer
Public classCamera
Class for managing the state of a camera.
Public classCanvasVisual
Public classCatalog
Class for implementing a persistent collection of visual factory objects.
Public classCatalogFolder
Class for implementing a folder or visual factories and folders within a catalog.
Public classCatalogEventArgs
EventArgs supplied to AfterCatalogLoaded or BeforeCatalogClosed events.
Public classChainConveyor
Class encapsulating the physics and rendering of a chain conveyor.
Public classChainJointVisual
Public classChainTransferVisual
Class encapsulating the behavior of 90 degree chain transfer conveyor visual.
Public classChainTurntableConveyor
Class encapsulating the behavior of a rotating chain conveyor.
Public classCollisionProxy
Public classComponentMembership
Public classConnector
Represents a location on an IConnectable object that another IConnectable object can connect to, via a suitable Connector of its own. When two Connectors are connected, their owning objects must be translated in space so that the respective Connector Location points coincide. Additionally, the orientation Normal may be used to align the two objects.
Public classContactImpulseInfo
Public classContactInfo
Class for handling low level processing of physics contact points. An instance of this is passed to the OnProcessContact event of certain visuals.
Public classContainerVisual
Class for representing boxes with sloping sides and optional faces. This is mostly used for representing the physics and graphics of a simple tote or crate object.
Public classConveyorMotorProperties
The state of a conveyor motor.
Public classConveyorSideCaps
Public classConveyorSideProperties
Public classConveyorVisual
Abstract class representing the behavior of conveyor visuals with a motor, and length and width.
Public classCurveBeltConveyor
Public classCurveConveyor
Abstract class encapsulating the behavior of a curved conveyor.
Public classCurveRollerConveyor
Public classCutoutProperties
Public classCylinderVisual
Cylinder primitive for physics and rendering.
Public classD3DFlatText
Public classDimensionProperties
Public classDistance2Property
Public classDistance3Property
Public classDiverterRollerConveyor
Class encapsulating the behavior of an angled divert roller or wheel conveyor.
Public classDocument
The Document class is the root for the currently loaded document.
Public classDocumentHeader
Public classDouble2PropertyControlPoint
Public classDrawingBlockVisual
Class that is used to render a set of lines as a single object. This class is used to host imported CAD line drawings (e.g. from DXF or DWG files) but can also be used for custom line drawings in the scene.
Public classDynamicConnector
Public classEndStopScriptReference
Public classExprAny
The Expr types can be used for ScriptAction parameters to allow the user to specify either a literal value or an expression.
Public classExprBool
Public classExprContext
Public classExprDouble
Public classExprInteger
Public classExprLoadFilter
Public classExprString
Public classExtension
Public classFBDynamicConnector
Public classFloorHitScriptReference
Public classFloorVisual
FloorVisual represents a floor which isn't the scene floor, such as a mezzanine.
Public classFrameRecordBase
Public classFrictionConfiguration
Public classFrictionMaterialCombination
Public classFrictionMaterialReference
Public classFrontDynamicConnector
Public classGroupObject
GroupObject is a Visual that isn't abstract.
Public classHandrailVisual
Summary description for HandrailVisual.
Public classImageReference
Public classImportedImageVisual
Class that is used to render a set an image. This class is used to render imported 2D images (e.g. from PNG or JPEG files).
Public classImportedMeshVisual
Class that is used to render a set of triangles as a single object. This class is used to host imported 3D CAD drawings (e.g. from Autodesk Inventor or SOLIDWORKS files).
Public classImportScriptReference
Public classInjectorBeltConveyor
Class encapsulating the behavior of a injector belt conveyor.
Public classInjectorConveyor
Abstract class representing the behavior of injector conveyor visuals with a motor, short side length, angle and width.
Public classInjectorRollerConveyor
Class encapsulating the behavior of a injector roller conveyor.
Public classJointVisual
Abstract class encapsulating the behavior of a physics joint (constraint) between other visuals.
Public classLayerReference
A weak, serializable, immutable reference to a Layer.
Public classLeftDynamicConnector
Public classLightVisual
Class encapsulating the behavior of a light visual (spot, point and directional).
Public classLoadCreatorItem
Properties of an individual Load Creator Item.
Public classLoadCreatorVisual
Introduce loads into the Events according to a plan (number and frequency).
Public classLoadFilter
Public classLoadFilterItem
Public classLRDynamicConnector
Public classMeshMaterial
Public classMeshObject
Abstract class that holds a 3D mesh object that can be rendered.
Public classModelInvokeExtensions
Public classMultiPropertyEdit
Public classNotifyDistanceInfo
Public classNotifyDistanceScriptReference
Public classNotifyMovementStatusScriptReference
Public classNotifySpeedChangeInfo
Public classNotifySpeedChangeScriptReference
Public classNotifySpeedInfo
Public classNotifySpeedScriptReference
Public classOnAnimatorCompletedScriptReference
Public classOnChildAddedScriptReference
Public classOnChildRemovedScriptReference
Public classOnClickScriptReference
Public classOnConnectedScriptReference
Public classOnDelayScriptReference
Public classOnDragEventScriptReference
Public classOnExportBindableItemScriptReference
Public classOnKeyEventArgs
Public classOnKeyPressEventArgs
Public classOnKeyPressScriptReference
Public classOnKeyScriptReference
Public classOnLoadAddedScriptReference
Public classOnLoadCreatedScriptReference
Public classOnLoadRemovedScriptReference
Public classOnMatrixUpdatedScriptReference
Public classOnMoveToCompletedScriptReference
Public classOnParentPropertyUpdatedScriptReference
Public classOnParentUpdatedScriptReference
Public classOnProcessContactScriptReference
Wrapper class for the OnProcessContact callback to allow changing of physics engine at a later date without problems for user scripts.
Public classOnPropertyRenamedScriptReference
Public classOnPropertyUpdatedScriptReference
Public classOnReportCollisionImpulseScriptReference
Public classOnSimulationTransferScriptReference
Public classOnSubscribedPropertyUpdatedScriptReference
Public classPhotoEye
Class encapsulating the behavior of a photo eye visual in terms of being a physics based sensor for sensing loads and vehicles but also having a graphical appearance.
Public classPhotoEyeScriptReference
Public classPhysicsBallSocketJoint
Represents a ball and socket joint that permits RigidBodyB to freely move and rotate but maintain a fixed distance from the pivot Position.
Public classPhysicsBody
The base type for physics bodies, including static bodies and rigid bodies.
Public classPhysicsBoxGeometry
Represents a box physics collision geometry.
Public classPhysicsCapsuleGeometry
Represents a capsule physics collision geometry.
Public classPhysicsCollision
Public classPhysicsCollisionImpulse
Public classPhysicsCompoundGeometry
Represents a compound/composite physics collision geometry.
Public classPhysicsConcaveTriangleMeshGeometry
Represents a concave triangle mesh physics collision geometry.
Public classPhysicsConeGeometry
Represents a cone physics collision geometry.
Public classPhysicsConvexHullGeometry
Represents a convex-hull physics collision geometry.
Public classPhysicsCylinderGeometry
Represents a cylinder physics collision geometry.
Public classPhysicsEngine
Public classPhysicsFixedJoint
Represents joint that constraints RigidBodyB to maintain a fixed position and orientation relative to RigidBodyA.
Public classPhysicsGeometry
The base type for physics collision geometry.
Public classPhysicsGroup
Identifies a collision group that physics bodies can be prescribed to. This is primarity used for fast collision pair elimination by specifying which pairs of groups collide.
Public classPhysicsHingeJoint
Represents a powered hinge, permitting RigidBodyB to orbit the hinge's Position about the hinge's Axis.
Public classPhysicsObject
Abstract class representing the a physical object of no particular shape. The derived classes implement different physics and graphics primitives such as boxes, spheres and cylinders. Physics objects can be used to represent the physics of loads, vehicles, sensors and deflectors. The physics can also be disabled making them only graphical.
Public classPhysicsRigidBody
Represents a dynamic or kinematic rigid body.
Public classPhysicsRigidBodyProperties
A container for properties used to instantiate a PhysicsRigidBody.
Public classPhysicsSliderJoint
Represents a powered slider/piston, permitting RigidBodyB to move only along the hinge's Axis. The rotation of RigidBodyA relative to RigidBodyB is locked.
Public classPhysicsSphereGeometry
Represents a spherical physics collision geometry.
Public classPhysicsStaticBody
Represents a static physics body, which has no mass or inertia tensor and does not respond dynamically to forces exerted upon it by other colliding bodies.
Public classPhysicsStaticBodyProperties
A container for properties used to instantiate a PhysicsStaticBody.
Public classPickInfo
The result of a pick from the scene.
Public classPluginAttribute
Attribute used in C# Scripting to indicate that this class should be loaded as a custom plugin.
Public classPointCloudVisual
Class representing a large collection of points in space. This is produced when importing a point cloud from an external file.
Public classPrismaticJointVisual
Class representing a physics joint for constraining physics enabled visuals along a straight line without rotation.
Public classProcessAnimator
Process that has fixed duration, and can be disabled, and allows custom animation
Public classPusherVisual
Class encapsulating the behavior of a pusher visual.
Public classQuantizedSpace
Public classQuickLogicAttribute
Annotate scripting functions with this attribute to create QuickLogic widgets Eg ///[QuickLogic("say hello to {message}")] function Hello( message : String ) { print("Hello " + message + "!"); } NOTE: QuickLogicAttribute also implies YieldReturn.
Public classQuickLogicProviderAttribute
Annotate classes and fields that provide additional QuickLogic definitions
Public classRackShelfBinLocation
Public classRackVisual
For a rack bay depth extends into the z axis, the rack bay width extends along the x axis.
Public classRay
Encapsulate the position and direction of a ray.
Public classRealtimeLagScriptReference
Public classRevoluteJointVisual
Class representing a physics joint for constraining physics enabled visuals around an axis of rotation with no linear movement along the axis.
Public classRightDynamicConnector
Public classRotationControlPointProperties
Public classScenePropertiesFrameRecord
Public classSceneVisual
A scene is the top-level visual that owns all other objects to be drawn, and also draws a floor.
Public classScriptingObject
Public classScriptReference
The ScriptReference class holds references to user callbacks that should be called when the event this ScriptReference refers to occurs. The arguments to the callbacks are of type (params object[] args).
Public classScriptReferenceT
The ScriptReference(T) class holds references to user callbacks that should be called when the event this ScriptReference refers to occurs. The arguments to the callbacks are of type (T sender).
Public classScriptReferenceT1, T2
The ScriptReference(T1, T2) class holds references to user callbacks that should be called when the event this ScriptReference refers to occurs. The arguments to the callbacks are of type (T1 sender, T2 arg).
Public classScriptReferenceT1, T2, T3
The ScriptReference(T1, T2, T3) class holds references to user callbacks that should be called when the event this ScriptReference refers to occurs. The arguments to the callbacks are of type (T1 sender, T2 arg1, T3 arg2).
Public classScriptReferenceT1, T2, T3, T4
The ScriptReference(T1, T2, T3, T4) class holds references to user callbacks that should be called when the event this ScriptReference refers to occurs. The arguments to the callbacks are of type (T1 sender, T2 arg1, T3 arg2, T4 arg3).
Public classSelection
Public classSensorScriptReference
Public classSensorVisual
Abstract class for modeling physics based sensors.
Public classShelfHitTestInfo
Public classShelfVisual
Class to manage the state of an area for storing loads. This can be a shelf in a rack or an area on a floor.
Public classSingleActionEditT
Public classSpeedProfile
Public classSphereVisual
The physics primitive type to use for the sphere visual.
Public classSphericalJointVisual
Class representing a physics joint for constraining physics enabled visuals to rotate freely around a point (a.k.a. a ball joint).
Public classStairVisual
The StairVisual stretches along the X axis in a positive direction, but ends and 0,0,0 for the top. The center is along z=0.
Public classStopBladeScriptReference
Public classStopBladeVisual
Class encapsulating the behavior of a stop blade visual.
Public classStraightBeltConveyor
Class encapsulating the behavior of a straight belt conveyor.
Public classStraightConveyor
Abstract class encapsulating the behavior of a straight conveyor.
Public classStraightRollerConveyor
Class encapsulating the behavior of a straight roller conveyor.
Public classSupportStand
A support stand is a conveyor visual accessory which is located at top of roller. There support stand is divided into 2 legs and 0 or more cross braces. Each leg has: * Floor Plate - which is attached at Props.FloorY (can be the ceiling) * Foot - which sits directly above (or below) the floor Plate * Leg - extends from the top of the foot to the bottom of the conveyor side * Coupling Plate - bolts the conveyor to the leg at the top of the leg There are 3 types of support stand. The Start, End and Splice. The conveyor will look for start and end and create them if they're not there. Splice stands have to be added in by hand currently. The position of the stands is controlled by a the Position expression where the conveyor is called "Attached".
Public classTcpConnectionEventArgs
Public classTextVisual
A visual for displaying text in the scene which can be extended to become a dimension visual.
Public classTrackingParentChangedScriptReference
Public classTrackingStopScriptReference
Public classTransfer
A transfer manages the exchange of loads between anything that can provide an ITransferController and ITransferPort.
Public classTransferScriptReference
Public classTransferState
Public classTurntableConveyor
Class encapsulating the behavior of a rotating straight roller conveyor.
Public classTurntableConveyorBase
Abstract class encapsulating the behavior of a rotating conveyor.
Public classUdpClientEventArgs
This interface clearly defines the API required by the ITool implementations
Public classUIFrameRecord
Public classCode exampleUserResource
Class representing a file which can be embedded in a model or catalog and can be referenced by visuals and scripts.
Public classCode exampleUserResourceReference
Class representing custom properties of type UserResource.
Public classUVCoords
Defines the texture coordinates for a square. Used for the image and box visuals.
Public classVector2Property
Public classVector3Property
Public classVisual
Abstract class that all 3D objects derive from.
Public classVisualEventArgs
Public classVisualFactory
Interface that allows the creation/editing of an type of visual.
Public classVisualList
Keep an list of visual references that can be sorted LIFO or FIFO, or any other sort order.
Public classVisualLocation
Public classVisualPropertyReference
Public classVisualReference
Public classVoxelizer
Public classWallVisual
Summary description for WallVisual.
Public classWebBrowserProperties
Public classWebBrowserVisual
Public classWebServerProperties
Public classWedgeVisual
Triangular prism primitive for physics and rendering.
Public classXamlReference
Custom property type that can hold per-instance XAML data or a reference to a shared UserResource.
Structures
  StructureDescription
Public structureBSphere
The bounding sphere of a mesh/visual. A zero radius sphere is ignored when combining two spheres.
Public structureScenePropertiesRecordUpdate
Public structureUIFrameRecordUpdate
Public structureZBufferDisable
Interfaces
  InterfaceDescription
Public interfaceIAnimationSettings
Provides access to the animation settings.
Public interfaceIBuilder
The top level application interface. This class provides services which apply to the whole application and are not specific to the currently loaded document.
Public interfaceIFillet
Public interfaceISceneAnimation
Public interfaceISensor
Interface for handling PhotoEye and PhysicsObject visuals as sensors in the same way.
Public interfaceITransferPortv2
Delegates
  DelegateDescription
Protected delegateBindableItemValueSourceChanged
Represents the method that will handle the ValueSourceChangedListeners event raised when a bindable item value is changed. BindableItem
Public delegatePrintDelegate
Public delegateProcessCollisionHandler
An alternative to using the ProcessCollision virtual method on a visual. This allows for notification of collisions against specific geometry in a visual. This is only useful when the visual's physics body has a compound geometry.
Public delegateScriptReferenceNativeListenersDelegate
Represents the method that will handle callbacks when the event for the ScriptReference occurs.
Public delegateScriptReferenceTNativeBlockingListenersDelegate
Represents the method that will handle resumable coroutine callbacks when the event for the ScriptReference occurs.
Public delegateScriptReferenceTNativeListenersDelegate
Represents the method that will handle callbacks when the event for the ScriptReference occurs. The first argument to the event callback.
Public delegateScriptReferenceTNativeTaskListenersDelegate
Represents the method that will handle resumable async Task callbacks when the event for the ScriptReference occurs.
Public delegateScriptReferenceT1, T2NativeBlockingListenersDelegate
Represents the method that will handle resumable coroutine callbacks when the event for the ScriptReference occurs.
Public delegateScriptReferenceT1, T2NativeListenersDelegate
Represents the method that will handle callbacks when the event for the ScriptReference occurs.
Public delegateScriptReferenceT1, T2NativeTaskListenersDelegate
Represents the method that will handle resumable async Task callbacks when the event for the ScriptReference occurs.
Public delegateScriptReferenceT1, T2, T3NativeBlockingListenersDelegate
Represents the method that will handle resumable coroutine callbacks when the event for the ScriptReference occurs.
Public delegateScriptReferenceT1, T2, T3NativeListenersDelegate
Represents the method that will handle callbacks when the event for the ScriptReference occurs.
Public delegateScriptReferenceT1, T2, T3NativeTaskListenersDelegate
Represents the method that will handle resumable async Task callbacks when the event for the ScriptReference occurs.
Public delegateScriptReferenceT1, T2, T3, T4NativeBlockingListenersDelegate
Represents the method that will handle resumable coroutine callbacks when the event for the ScriptReference occurs.
Public delegateScriptReferenceT1, T2, T3, T4NativeListenersDelegate
Represents the method that will handle callbacks when the event for the ScriptReference occurs.
Public delegateScriptReferenceT1, T2, T3, T4NativeTaskListenersDelegate
Represents the method that will handle resumable async Task callbacks when the event for the ScriptReference occurs.
Public delegateUdpClientEventHandler
Public delegateVectorDelegate
Enumerations
  EnumerationDescription
Public enumerationAttachDirection
Specify how to align the object's X-Axis with the Visual's "forwards" direction (e.g. X-Axis for a Straight Conveyor).
Public enumerationBeltConveyorCenterCollisionType
The physics collision geometry type to use for the center of belt conveyor.
Protected enumerationBindableItemValueSource
The source of the value that's changing/changed.
Public enumerationBoxTextureMode
The texture mapping algorithm to use for the box visual.
Public enumerationBoxTubeCollisionType
The physics primitive type to use for the box tube visual.
Public enumerationBoxTubeCornerStyle
The corner style for a box tube visual.
Public enumerationConnectorAlignment
Controls how to align two IConnectable objects (Visuals) when calling Connector.Connect().
Public enumerationConnectorAlignmentStyle
Represents the way in which objects align with each other when they snap together.
Public enumerationConveyorBodyType
The physics mode for a conveyor visual.
Public enumerationConveyorSideCollisionType
The physics collision geometry type to use for the sides of conveyors.
Public enumerationCylinderCollisionType
The physics primitive type to use for the cylinder visual.
Public enumerationCylinderTextureMode
The texture mapping algorithm to use for the cylinder visual.
Public enumerationDimensionUnit
Allow the unit of a Dimension to be changed from the default
Public enumerationDiverterComponent
The type of divert component graphic to use.
Public enumerationDocumentLookOptions
Options when looking for visuals.
Public enumerationFloorCollisionType
The physics collision geometry type to use for the floor surface.
Public enumerationFrameDetail
Public enumerationGeometryType
The types of physics collision geometry.
Public enumerationHorizontalAlign
The horizontal alignment of text.
Public enumerationImageBackFace
Control how the back of the imported image visual is displayed.
Public enumerationInfeedOutfeedConveyorType
Public enumerationJointType
The types of physics joint.
Public enumerationLiftDirection
Public enumerationLiftState
Public enumerationLoadReleaseStrategy
Sequence - Release in the order they appear in the Items list. Distribution - Release using the quantity/total quantity as the probability that item will be released.
Public enumerationMatrixUpdateType
The enumeration that is supplied to OnMoved events indicating whether it was a direct update to a visual's matrix (location and rotation) or whether the update was made by the physics engine.
Public enumerationMessageBoxType
Public enumerationMotorDirection
Public enumerationMotorState
Public enumerationMovementStatus
Conveyor motor movement categorization.
Public enumerationPhysicsBodyType
The physics to create for a PhysicsObject.
Public enumerationPhysicsCollisionType
Public enumerationPhysicsEngineEngineType
Enumeration of the available physics engines.
Public enumerationPickMode
Public enumerationPickType
Public enumerationProcessContactResult
The result of an OnProcessContact notification for low level handling of physics contact events.
Public enumerationProxyFlags
Public enumerationPulseGenerationMode
Pulse generation mode.
Public enumerationRollerConveyorCenterCollisionType
The physics collision geometry type to use for the center of roller conveyor.
Public enumerationRotationDirection
Public enumerationRunMode
Public enumerationShadowRenderStyle
The style of the Shadows in the Scene.
Public enumerationShelfDetail
Control the detail of shelf visualization.
Public enumerationShelfOrder
Control the order in which to populate loads on a shelf.
Public enumerationSideCapShape
Public enumerationSideCapStates
Public enumerationSupportStandType
Type of support stand.
Public enumerationTargetLiftState
Public enumerationTargetStop
Public enumerationTargetTiltState
Public enumerationTiltState
Public enumerationTrackingDirection
Public enumerationTrackingMode
Public enumerationTransferDirection
Direction transfers can be made in or out of a connector (or neither or both).
Public enumerationTurntableDirection
Direction to rotate a turntable conveyor.
Remarks
All classes and methods documented here are intended for use in user scripting.