LightSourceEntity Members

Microsoft Robotics Class Reference

The LightSourceEntity type exposes the following members.

Constructors

	Name	Description
	LightSourceEntity() () () ()	Default constructor, uses point light type
	LightSourceEntity(LightSourceEntityType)	Initialization constructor

Methods

	Name	Description
	AddShapeToPhysicsEntity	Adds a shape dynamically to an already initialized physics entity (Inherited from VisualEntity.)
	BeginBatchRender(String, array Fields   Name Description NeedsReplacement Internal use: marks this entity for replacement (Inherited from Entity.) State State (Inherited from Entity.) SuspendUpdates Internal use: suspends physics engine updates on this entity (Inherited from Entity.) Properties   Name Description 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.) CastsShadows Gets or sets whether the light creates shadows ChildCount Number of children, used in serialization and deserialization of VisualEntities (Inherited from VisualEntity.) Children Runtime only list of child entities so simulation engine can render and update on our behalf (Inherited from VisualEntity.) Color Gets the normalized color of the light 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.) Device Current graphics device (Inherited from VisualEntity.) Direction Get or set the direction that the light is pointing Effect Vertex and pixel shader effect file (*.fx). If not specified, default effect is used (Inherited from VisualEntity.) EmbeddedResourceAssemblies List of assemblies contain embedded resources this entity needs to be properly loaded (Inherited from VisualEntity.) EntityBoundingSphere Bounding sphere approximating collision mesh for entity (Inherited from VisualEntity.) EntityState This field exposes the entity state so that the simulation editor can access it. (Inherited from VisualEntity.) EntityWorldBoundingSphere Bounding sphere approximating collision mesh for entity (Inherited from VisualEntity.) FalloffEnd Ending falloff for a point or spot light FalloffStart Starting falloff for a point or spot light Flags Flags which define the rendering and behavior of this entity. (Inherited from VisualEntity.) HasBeenInitialized true if this VisualEntity has been successfully initialized (Inherited from VisualEntity.) InitError Contains a description of any errors that occurred during initialization (Inherited from VisualEntity.) InternalHandle Simulation internal use (Inherited from Entity.) Meshes DirectX meshes used for rendering the entity in 3D (Inherited from VisualEntity.) MeshRotation Gets or sets the rotation of the entity meshes (Inherited from VisualEntity.) MeshScale Gets or sets the scale of the entity meshes (Inherited from VisualEntity.) MeshTransform Get the local transform the entity uses on its meshes (Inherited from VisualEntity.) MeshTranslation Gets or sets the translation of the entity meshes (Inherited from VisualEntity.) Parent Optional Parent entity. (Inherited from VisualEntity.) 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.) PhysicsEngine Physics Engine instance (Inherited from VisualEntity.) PhysicsEntity Instance used for modifying and inspecting physics simulation behavior for this entity (Inherited from VisualEntity.) 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.) Position This field exposes the entity position as an xna.Vector3 so that the simulation editor can access it. (Inherited from VisualEntity.) 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.) RenderPhysicsPrimitives True if simplified rendering (using just physics geometry) is requests (Inherited from VisualEntity.) Rotation This field exposes the entity rotation so that the simulation editor can access it. (Inherited from VisualEntity.) RotationAngles This field exposes the entity rotation converted to Euler angles from the orientation quaternion. (Inherited from VisualEntity.) RotationAnglesInWorldSpace This field exposes the entity rotation in world space converted to Euler angles from the orientation quaternion. (Inherited from VisualEntity.) ServiceContract The contract for a service associated with this entity. (Inherited from VisualEntity.) SpotUmbra Angle of cone created by a spotlight Type Get or set the light type 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.) World World transform (Inherited from VisualEntity.) See Also LightSourceEntity Class Microsoft.Robotics.Simulation.Engine Namespace