Share via


IREntity Members

Microsoft Robotics Class Reference

The IREntity type exposes the following members.

Constructors

  Name Description
Public method IREntity() () () ()
Default constructor
Public method IREntity(Pose)
Initialization constructor
Public method IREntity(Pose, Single, Single, Single)
Initialization constructor

Methods

  Name Description
Public method AddShapeToPhysicsEntity
Adds a shape dynamically to an already initialized physics entity
(Inherited from VisualEntity.)
Public method AddSurface
Add a PictureBox container to display the results of each render from this camera.
(Inherited from CameraEntity.)
Protected method BeginBatchRender(String, array

Fields

  Name Description
Public field NeedsReplacement
Internal use: marks this entity for replacement
(Inherited from Entity.)
Public field RecentImage
Indicates that an image was rendered with this camera last frame
(Inherited from CameraEntity.)
Public field State
State
(Inherited from Entity.)
Public field SuspendUpdates
Internal use: suspends physics engine updates on this entity
(Inherited from Entity.)

Properties

  Name Description
Public property AddsShapeToParent
Indicates that this entity must be a child entity and that it adds one or more shapes to its parent rather than defining its own shapes.
(Inherited from VisualEntity.)
Public property Aspect
Aspect ratio (width/height) of the camera view (read-only)
(Inherited from CameraEntity.)
Public property CameraModel
Specifies the model used by the camera entity.
(Inherited from CameraEntity.)
Public property ChildCount
Number of children, used in serialization and deserialization of VisualEntities
(Inherited from VisualEntity.)
Public property Children
Runtime only list of child entities so simulation engine can render and update on our behalf
(Inherited from VisualEntity.)
Public property DeferredTaskQueue
To avoid contention with physics simulation which runs in a different thread than what the entity APIs might get called in, we just package up the parameters and queue CCR tasks. During the Update method we then process the queued requests
(Inherited from VisualEntity.)
Public property Device
Current graphics device
(Inherited from VisualEntity.)
Public property Effect
Vertex and pixel shader effect file (*.fx). If not specified, default effect is used
(Inherited from VisualEntity.)
Public property EmbeddedResourceAssemblies
List of assemblies contain embedded resources this entity needs to be properly loaded
(Inherited from VisualEntity.)
Public property EntityBoundingSphere
Bounding sphere approximating collision mesh for entity
(Inherited from VisualEntity.)
Public property EntityState
This field exposes the entity state so that the simulation editor can access it.
(Inherited from VisualEntity.)
Public property EntityWorldBoundingSphere
Bounding sphere approximating collision mesh for entity
(Inherited from VisualEntity.)
Public property Eye
Eye point of camera
(Inherited from CameraEntity.)
Public property Far
Distance to the far clipping plane
(Inherited from CameraEntity.)
Public property FieldOfView
Camera vertical resolution in degrees
(Inherited from CameraEntity.)
Public property Flags
Flags which define the rendering and behavior of this entity.
(Inherited from VisualEntity.)
Public property Forward
Look vector of camera
(Inherited from CameraEntity.)
Public property HasBeenInitialized
true if this VisualEntity has been successfully initialized
(Inherited from VisualEntity.)
Public property Height
Camera vertical resolution (read-only)
(Inherited from CameraEntity.)
Public property InitError
Contains a description of any errors that occurred during initialization
(Inherited from VisualEntity.)
Public property InternalHandle
Simulation internal use
(Inherited from Entity.)
Public property IsPhysicsVisible
If true the camera can interact with the physics simulation
(Inherited from CameraEntity.)
Public property IsRealTimeCamera
If true the camera is a realtime camera and renders at each frame
(Inherited from CameraEntity.)
Public property LatestReading
Latest reading
(Inherited from DepthCamBasedRaycastSensorEntity.)
Public property LensEffect
Custom lens effect used for rendering
(Inherited from CameraEntity.)
Public property Location
The location of the camera
(Inherited from CameraEntity.)
Public property LookAt
The center of the camera view
(Inherited from CameraEntity.)
Public property MaximumRange
The maximum range of this sensor
(Inherited from DepthCamBasedRaycastSensorEntity.)
Public property Meshes
DirectX meshes used for rendering the entity in 3D
(Inherited from VisualEntity.)
Public property MeshRotation
Gets or sets the rotation of the entity meshes
(Inherited from VisualEntity.)
Public property MeshScale
Gets or sets the scale of the entity meshes
(Inherited from VisualEntity.)
Public property MeshTransform
Get the local transform the entity uses on its meshes
(Inherited from VisualEntity.)
Public property MeshTranslation
Gets or sets the translation of the entity meshes
(Inherited from VisualEntity.)
Public property MinimumRange
The minimum range of this sensor
(Inherited from DepthCamBasedRaycastSensorEntity.)
Public property Near
Distance to the near clipping plane
(Inherited from CameraEntity.)
Public property Parent
Optional Parent entity.
(Inherited from VisualEntity.)
Public property ParentJoint
Gets the joint that connects this entity to its parent. Null if either this or parent do not have physics entity.
(Inherited from VisualEntity.)
Public property PhysicsEngine
Physics Engine instance
(Inherited from VisualEntity.)
Public property PhysicsEntity
Instance used for modifying and inspecting physics simulation behavior for this entity
(Inherited from VisualEntity.)
Public property PhysicsJoint
Gets the joint that connects this entity to its parent. Null if either this or parent do not have physics entity.
(Inherited from VisualEntity.)
Public property Position
This field exposes the entity position as an xna.Vector3 so that the simulation editor can access it.
(Inherited from VisualEntity.)
Public property ProjectionMatrix
Projection matrix
(Inherited from CameraEntity.)
Public property ReadSurface
Surface we read from
(Inherited from CameraEntity.)
Public property ReferenceFrame
Specifies the meaning of the entity's position This is used for serialization and to help with joining child entities. It is not meant to be changed outside of the simulation engine.
(Inherited from VisualEntity.)
Public property RenderPhysicsPrimitives
True if simplified rendering (using just physics geometry) is requests
(Inherited from VisualEntity.)
Public property Rotation
This field exposes the entity rotation so that the simulation editor can access it.
(Inherited from VisualEntity.)
Public property RotationAngles
This field exposes the entity rotation converted to Euler angles from the orientation quaternion.
(Inherited from VisualEntity.)
Public property RotationAnglesInWorldSpace
This field exposes the entity rotation in world space converted to Euler angles from the orientation quaternion.
(Inherited from VisualEntity.)
Public property ServiceContract
The contract for a service associated with this entity.
(Inherited from VisualEntity.)
Public property ShaderFile
The filename of the HLSL file to use as a depth camera pixel shader
(Inherited from DepthCameraEntity.)
Public property ShadowDisplay
Gets or sets whether the camera should be rendering shadows
(Inherited from CameraEntity.)
Public property UpdateInterval
This time indicates the amount of time between frame updates in milliseconds. 0 means that the camera never updates on its own but must be queried.
(Inherited from CameraEntity.)
Public property UsesSphereCulling
this entity uses frustum culling on rendering affected by children in this entity's hierarchy default is true, but should be false for (special effects, terrain, invisible objs) if true, a valid bounding sphere should be present we should make this internal, since we expose the DisableViewFrustumCulling flag, and this flag is with respect to the the hierarchy which the user shouldn't be able to set however, making this internal could is a breaking change to user code, do we really want to do this -- not at the moment at least
(Inherited from VisualEntity.)
Public property ViewAngle
Rendering camera FOV angle, used for offscreen realtime camera rendering careful, this angle is in fact HALF of the total FOV can only be initialized at constuction time
(Inherited from CameraEntity.)
Public property ViewMatrix
View matrix
(Inherited from CameraEntity.)
Public property ViewSizeX
Camera horizontal resolution, used for offscreen realtime camera rendering can only be initialized at constuction time
(Inherited from CameraEntity.)
Public property ViewSizeY
Camera vertical resolution, used for offscreen realtime camera rendering can only be initialized at constuction time
(Inherited from CameraEntity.)
Public property Width
Camera horizontal resolution (read-only)
(Inherited from CameraEntity.)
Public property World
World transform
(Inherited from VisualEntity.)
Public property WriteSurface
Surface we write to
(Inherited from CameraEntity.)

See Also

IREntity Class

Microsoft.Robotics.Simulation.Engine Namespace