SpotLight Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Light object that projects its effect in a cone-shaped area along a specified direction.
public ref class SpotLight sealed : System::Windows::Media::Media3D::PointLightBasepublic sealed class SpotLight : System.Windows.Media.Media3D.PointLightBasetype SpotLight = class
inherit PointLightBasePublic NotInheritable Class SpotLight
Inherits PointLightBase- Inheritance
Examples
The following example shows how to create a SpotLight in a 3-D scene.
<!-- A SpotLight is used to light the scene. The InnerConeAngle and OuterConeAngle are used
to control the size of the light cone created by the SpotLight. The Direction and Position
properties determine where the SpotLight is pointing in the scene. In this example, the Position
of the SpotLight is set so that the SpotLight is only illuminating the upper right-hand corner
of the 3D object. -->
<ModelVisual3D>
<ModelVisual3D.Content>
<SpotLight x:Name="mySpotLight" InnerConeAngle="20" OuterConeAngle="20" Color="#FFFFFF" Direction="0,0,-1"
Position="1,1,6" Range="20"/>
</ModelVisual3D.Content>
</ModelVisual3D>
The following code shows the entire sample.
<Page xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" >
<DockPanel>
<Viewbox>
<Canvas Width="321" Height="201">
<!-- The Viewport3D provides a rendering surface for 3-D visual content. -->
<Viewport3D ClipToBounds="True" Width="150" Height="150" Canvas.Left="0" Canvas.Top="10">
<!-- Defines the camera used to view the 3D object. -->
<Viewport3D.Camera>
<PerspectiveCamera Position="0,0,2" LookDirection="0,0,-1" FieldOfView="60" />
</Viewport3D.Camera>
<!-- The ModelVisual3D children contain the 3D models -->
<Viewport3D.Children>
<!-- A SpotLight is used to light the scene. The InnerConeAngle and OuterConeAngle are used
to control the size of the light cone created by the SpotLight. The Direction and Position
properties determine where the SpotLight is pointing in the scene. In this example, the Position
of the SpotLight is set so that the SpotLight is only illuminating the upper right-hand corner
of the 3D object. -->
<ModelVisual3D>
<ModelVisual3D.Content>
<SpotLight x:Name="mySpotLight" InnerConeAngle="20" OuterConeAngle="20" Color="#FFFFFF" Direction="0,0,-1"
Position="1,1,6" Range="20"/>
</ModelVisual3D.Content>
</ModelVisual3D>
<ModelVisual3D>
<ModelVisual3D.Content>
<GeometryModel3D>
<!-- The geometry specifies the shape of the 3D plane. In this sample, a flat sheet is created. -->
<GeometryModel3D.Geometry>
<MeshGeometry3D
TriangleIndices="0,1,2 3,4,5 "
Normals="0,0,1 0,0,1 0,0,1 0,0,1 0,0,1 0,0,1 "
TextureCoordinates="0,0 1,0 1,1 1,1 0,1 0,0 "
Positions="-0.5,-0.5,0.5 0.5,-0.5,0.5 0.5,0.5,0.5 0.5,0.5,0.5 -0.5,0.5,0.5 -0.5,-0.5,0.5 " />
</GeometryModel3D.Geometry>
<!-- The material specifies the material applied to the 3D object. In this sample a linear gradient
covers the surface of the 3D object.-->
<GeometryModel3D.Material>
<MaterialGroup>
<DiffuseMaterial>
<DiffuseMaterial.Brush>
<LinearGradientBrush StartPoint="0,0.5" EndPoint="1,0.5">
<LinearGradientBrush.GradientStops>
<GradientStop Color="Yellow" Offset="0" />
<GradientStop Color="Red" Offset="0.25" />
<GradientStop Color="Blue" Offset="0.75" />
<GradientStop Color="LimeGreen" Offset="1" />
</LinearGradientBrush.GradientStops>
</LinearGradientBrush>
</DiffuseMaterial.Brush>
</DiffuseMaterial>
</MaterialGroup>
</GeometryModel3D.Material>
</GeometryModel3D>
</ModelVisual3D.Content>
</ModelVisual3D>
</Viewport3D.Children>
</Viewport3D>
</Canvas>
</Viewbox>
</DockPanel>
</Page>
Remarks
SpotLight is a kind of PointLight, since it has a position, range, and attenuation. However, SpotLight also allows you to control the direction, shape, and other properties of the cone of the light's effect.
Specify values for OuterConeAngle (beyond which nothing is illuminated), and InnerConeAngle (within which everything is fully illuminated) to change the spotlighting effect.
Lighting between the outside of the inner cone and the outer cone falls off linearly.
Constructors
| SpotLight() |
Initializes a new instance of the SpotLight class. |
| SpotLight(Color, Point3D, Vector3D, Double, Double) |
Initializes a new instance of the SpotLight class using the specified color, position, direction, and cone angles. |
Fields
| DirectionProperty |
Identifies the Direction dependency property. |
| InnerConeAngleProperty |
Identifies the InnerConeAngle dependency property. |
| OuterConeAngleProperty |
Identifies the OuterConeAngle dependency property. |
Properties
| Bounds |
Gets a Rect3D that specifies the axis-aligned bounding box of this Model3D. (Inherited from Model3D) |
| CanFreeze |
Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable) |
| Color |
Gets or sets the color of the light. (Inherited from Light) |
| ConstantAttenuation |
Gets or sets a constant value by which the intensity of the light diminishes over distance. (Inherited from PointLightBase) |
| DependencyObjectType |
Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject) |
| Direction |
Gets or sets a Vector3D that specifies the direction in which the SpotLight projects its light. |
| Dispatcher |
Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject) |
| HasAnimatedProperties |
Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable) |
| InnerConeAngle |
Gets or sets an angle that specifies the proportion of a SpotLight's cone-shaped projection in which the light fully illuminates objects in the scene. |
| IsFrozen |
Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable) |
| IsSealed |
Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject) |
| LinearAttenuation |
Gets or sets a value that specifies the linear diminution of the light's intensity over distance. (Inherited from PointLightBase) |
| OuterConeAngle |
Gets or sets an angle that specifies the proportion of a SpotLight's cone-shaped projection outside which the light does not illuminate objects in the scene. |
| Position |
Gets or sets a Point3D that specifies the light's position in world space. (Inherited from PointLightBase) |
| QuadraticAttenuation |
Gets or sets a value that specifies the diminution of the light's effect over distance, calculated by a quadratic operation. (Inherited from PointLightBase) |
| Range |
Gets or sets the distance beyond which the light has no effect. (Inherited from PointLightBase) |
| Transform |
Gets or sets the Transform3D set on the model. (Inherited from Model3D) |
Methods
| ApplyAnimationClock(DependencyProperty, AnimationClock) |
Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable) |
| ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior) |
Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable) |
| BeginAnimation(DependencyProperty, AnimationTimeline) |
Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable) |
| BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior) |
Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable) |
| CheckAccess() |
Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject) |
| ClearValue(DependencyProperty) |
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject) |
| ClearValue(DependencyPropertyKey) |
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject) |
| Clone() |
Creates a modifiable clone of this SpotLight, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. |
| CloneCore(Freezable) |
Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. (Inherited from Freezable) |
| CloneCurrentValue() |
Creates a modifiable clone of this SpotLight object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are. |
| CloneCurrentValueCore(Freezable) |
Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. (Inherited from Freezable) |
| CoerceValue(DependencyProperty) |
Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject) |
| CreateInstance() |
Initializes a new instance of the Freezable class. (Inherited from Freezable) |
| CreateInstanceCore() |
When implemented in a derived class, creates a new instance of the Freezable derived class. (Inherited from Freezable) |
| Equals(Object) |
Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject) |
| Freeze() |
Makes the current object unmodifiable and sets its IsFrozen property to |
| FreezeCore(Boolean) |
Makes this Animatable object unmodifiable or determines whether it can be made unmodifiable. (Inherited from Animatable) |
| GetAnimationBaseValue(DependencyProperty) |
Returns the non-animated value of the specified DependencyProperty. (Inherited from Animatable) |
| GetAsFrozen() |
Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable) |
| GetAsFrozenCore(Freezable) |
Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values. (Inherited from Freezable) |
| GetCurrentValueAsFrozen() |
Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable) |
| GetCurrentValueAsFrozenCore(Freezable) |
Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied. (Inherited from Freezable) |
| GetHashCode() |
Gets a hash code for this DependencyObject. (Inherited from DependencyObject) |
| GetLocalValueEnumerator() |
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| GetValue(DependencyProperty) |
Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject) |
| InvalidateProperty(DependencyProperty) |
Re-evaluates the effective value for the specified dependency property. (Inherited from DependencyObject) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| OnChanged() |
Called when the current Freezable object is modified. (Inherited from Freezable) |
| OnFreezablePropertyChanged(DependencyObject, DependencyObject) |
Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable) |
| OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) |
This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from Freezable) |
| OnPropertyChanged(DependencyPropertyChangedEventArgs) |
Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable) |
| ReadLocalValue(DependencyProperty) |
Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject) |
| ReadPreamble() |
Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. (Inherited from Freezable) |
| SetCurrentValue(DependencyProperty, Object) |
Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject) |
| SetValue(DependencyProperty, Object) |
Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject) |
| SetValue(DependencyPropertyKey, Object) |
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject) |
| ShouldSerializeProperty(DependencyProperty) |
Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject) |
| ToString() |
Creates a string representation of the Model3D. (Inherited from Model3D) |
| ToString(IFormatProvider) |
Creates a string representation of the Model3D. (Inherited from Model3D) |
| VerifyAccess() |
Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject) |
| WritePostscript() |
Raises the Changed event for the Freezable and invokes its OnChanged() method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. (Inherited from Freezable) |
| WritePreamble() |
Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable) |
Events
| Changed |
Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable) |
Explicit Interface Implementations
| IFormattable.ToString(String, IFormatProvider) |
Formats the value of the current instance using the specified format. (Inherited from Model3D) |
