Struct ServerDistantLight 

pub struct ServerDistantLight { /* private fields */ }

The server-side counterpart of a DistantLight.

Implementations

impl ServerDistantLight

pub fn new(compositor: &Rc<ServerCompositor>) -> Rc<ServerDistantLight>

Creates the light, active and registered with its compositor: the UI-thread light activates its server object when it is created.

pub fn props(&self) -> &ServerDistantLightProps

The properties of the light.

pub fn is_disposed(&self) -> bool

Trait Implementations

impl IAnimatedServerObject for ServerDistantLight

fn server_object(&self) -> &ServerObject

The embedded ServerObject part.

fn get_composition_property( &self, field_name: &str, ) -> Option<&'static CompositionProperty>

The composition property with the given name, if the class has one.

fn as_server_object_dyn(&self) -> &dyn IServerObject

The object as the base contract (an explicit upcast).

fn read_property_variant( &self, property: &'static CompositionProperty, ) -> ExpressionVariant

Reads a property of the object as a variant. The default reads the field through CompositionProperty::get_variant; an object with dynamic properties (a property set) reads its own storage.

fn write_property_variant( &self, property: &'static CompositionProperty, value: ExpressionVariant, )

Writes a variant into a property of the object without notification (what an animation does with the value it evaluated). The default writes the field through CompositionProperty::set_variant; an object with dynamic properties writes its own storage.

impl IServerAnimatedPropertyHost for ServerDistantLight

fn set_animated_value( &self, property: &'static CompositionProperty, current_value: ExpressionVariant, committed_at: Duration, animation: Rc<dyn IAnimationInstance>, )

SetAnimatedValue(prop, ref field, committedAt, animation): starts animation on the property. current_value is the value of the field as a variant; the animation writes the field through CompositionProperty::set_variant.

fn remove_animation_for_property(&self, property: &'static CompositionProperty)

The tail of SetAnimatedValue(prop, out field, value): the field has been assigned directly, so the animation of the property, if any, is removed.

fn notify_animated_value_changed(&self, _property: &'static CompositionProperty)

An animation wrote a new value into the field of property.

impl IServerCompositionLight for ServerDistantLight

fn light_props(&self) -> &ServerCompositionLightProps

The properties of CompositionLight.

fn light_state(&self) -> &ServerLightState

The bookkeeping of what the light lit.

fn is_disposed(&self) -> bool

fn coordinate_space(&self) -> Option<Rc<ServerCompositionVisual>>

The visual whose coordinates the light is in; None for the targeted visual (and for an ambient light, which has no position).

fn source(&self) -> LightSource

The light in its coordinate space.

fn target_of( &self, visual: &ServerCompositionVisual, ) -> Option<Rc<ServerCompositionVisual>>

Whether visual is lit by the light: in the subtree of a target and not in the subtree of an exclusion (an exclusion that is also a target is excluded). The target, if it is.

impl IServerObject for ServerDistantLight

fn deserialize_changes_core( &self, reader: &mut BatchStreamReader<'_>, committed_at: Duration, )

Reads the changes of the object from a batch.

fn values_invalidated(&self)

Called after a group of values of the object changed.

fn dispose(&self)

Releases the object: it has been disposed on the UI thread.

fn as_render_resource(self: Rc<Self>) -> Option<Rc<dyn IServerRenderResource>>

The object as a render resource, if it is one.

fn as_animated(self: Rc<Self>) -> Option<Rc<dyn IAnimatedServerObject>>

The object as an animatable object, if it is one.

fn get_props(&self, type_id: TypeId) -> Option<&dyn Any>

The generated property block of the given type embedded in the object, if it has one. A class that embeds generated properties forwards to their find_props; composition properties locate their fields through it.

fn as_any(&self) -> &dyn Any

fn into_any_rc(self: Rc<Self>) -> Rc<dyn Any>

fn deserialize_changes( &self, reader: &mut BatchStreamReader<'_>, committed_at: Duration, )

Applies the changes of the object from a batch.

fn as_brush(self: Rc<Self>) -> Option<Rc<dyn IBrush>>

The object as a brush, if it is a server-side brush.

fn as_pen(self: Rc<Self>) -> Option<Rc<dyn IPen>>

The object as a pen, if it is a server-side pen.

fn as_render_data_geometry( self: Rc<Self>, ) -> Option<Rc<dyn IRenderDataGeometry>>

The object as a geometry usable by render data, if it is a server-side geometry.

fn as_transform(self: Rc<Self>) -> Option<Rc<dyn ITransform>>

The object as a transform, if it is a server-side transform.

fn as_gradient_stop(self: Rc<Self>) -> Option<Rc<dyn IGradientStop>>

The object as a gradient stop, if it is a server-side gradient stop.

fn as_surface(self: Rc<Self>) -> Option<Rc<dyn IServerCompositionSurface>>

The object as a composition surface, if it is one.

impl IServerPropertyHost for ServerDistantLight

fn server_compositor(&self) -> Option<Rc<ServerCompositor>>

The compositor of the object, while it is alive. Used to resolve the server objects a batch refers to.

fn set_value( &self, _property: &'static CompositionProperty, change: ServerValueChange<'_>, )

SetValue(prop, ref field, value) as the class of the object defines it. A plain server object assigns; an animated object also invalidates the subscriptions of the property; a render resource goes through super::ServerRenderResourceCore::set_value.

impl IServerRenderResource for ServerDistantLight

fn add_observer(&self, observer: &Rc<dyn IServerRenderResourceObserver>)

fn remove_observer(&self, observer: &Rc<dyn IServerRenderResourceObserver>)

fn queued_invalidate(&self)

impl IServerRenderResourceHost for ServerDistantLight

fn compositor(&self) -> Option<Rc<ServerCompositor>>

The compositor of the resource, while it is alive.

fn as_render_resource_rc(&self) -> Option<Rc<dyn IServerRenderResource>>

The resource as a shared handle, for the invalidation queue.

fn resource_property_changed(&self)

Called once per group of property changes, before the queued invalidation.

impl IServerRenderResourceObserver for ServerDistantLight

fn dependency_queued_invalidate(&self, _sender: &dyn IServerRenderResource)

impl ServerCompositionLightHooks for ServerDistantLight

fn deserialize_changes_extra(&self, _reader: &mut BatchStreamReader<'_>)

fn on_fields_deserialized(&self, _changed: CompositionLightChangedFields)

fn on_targets_changed(&self)

fn on_targets_changing(&self)

fn on_exclusions_from_targets_changed(&self)

fn on_exclusions_from_targets_changing(&self)

fn on_is_enabled_changed(&self)

fn on_is_enabled_changing(&self)

impl ServerDistantLightHooks for ServerDistantLight

fn deserialize_changes_extra(&self, _reader: &mut BatchStreamReader<'_>)

fn on_fields_deserialized(&self, _changed: DistantLightChangedFields)

fn on_coordinate_space_changed(&self)

fn on_coordinate_space_changing(&self)