Struct OutlineEffect2D

pub struct OutlineEffect2D(/* private fields */);

Use OutlineEffect2D to apply an outline to the content of 2D nodes.

Examples

To create an outline effect:

To set the outline effect properties:

See: NodeEffect2D, NodeEffectPrefab2D, NodeEffectTemplate2D

Since

Kanzi 3.9.5

Implementations

impl OutlineEffect2D

pub fn create( domain: &Domain, name: impl AsRef<KanziStr>, ) -> Result<OutlineEffect2D, Error>

Creates an outline effect.

Arguments

• domain - Domain to use.
• name - Resource name.

Returns

Shared pointer to the created OutlineEffect2D instance.

impl OutlineEffect2D

pub fn get_blend_mode(&self) -> Result<i32, Error>

See: BLEND_MODE_PROPERTY

pub fn set_blend_mode(&self, value: i32) -> Result<(), Error>

See: BLEND_MODE_PROPERTY

pub fn get_width(&self) -> Result<i32, Error>

See: WIDTH_PROPERTY

pub fn set_width(&self, value: i32) -> Result<(), Error>

See: WIDTH_PROPERTY

pub fn get_color(&self) -> Result<ColorRGBA, Error>

See: COLOR_PROPERTY

pub fn set_color(&self, value: ColorRGBA) -> Result<(), Error>

See: COLOR_PROPERTY

pub fn get_softness(&self) -> Result<f32, Error>

See: SOFTNESS_PROPERTY

pub fn set_softness(&self, value: f32) -> Result<(), Error>

See: SOFTNESS_PROPERTY

pub fn get_inner_width(&self) -> Result<i32, Error>

See: INNER_WIDTH_PROPERTY

pub fn set_inner_width(&self, value: i32) -> Result<(), Error>

See: INNER_WIDTH_PROPERTY

pub fn get_inner_softness(&self) -> Result<f32, Error>

See: INNER_SOFTNESS_PROPERTY

pub fn set_inner_softness(&self, value: f32) -> Result<(), Error>

See: INNER_SOFTNESS_PROPERTY

pub fn get_texture(&self) -> Result<Option<Weak<Resource>>, Error>

See: TEXTURE_PROPERTY

pub fn set_texture(&self, value: Option<&Resource>) -> Result<(), Error>

See: TEXTURE_PROPERTY

pub fn get_texture_offset(&self) -> Result<f32, Error>

See: TEXTURE_OFFSET_PROPERTY

pub fn set_texture_offset(&self, value: f32) -> Result<(), Error>

See: TEXTURE_OFFSET_PROPERTY

pub fn get_texture_tiling(&self) -> Result<f32, Error>

See: TEXTURE_TILING_PROPERTY

pub fn set_texture_tiling(&self, value: f32) -> Result<(), Error>

See: TEXTURE_TILING_PROPERTY

pub fn get_content_mask(&self) -> Result<Vector4, Error>

See: CONTENT_MASK_PROPERTY

pub fn set_content_mask(&self, value: Vector4) -> Result<(), Error>

See: CONTENT_MASK_PROPERTY

pub fn get_content_threshold(&self) -> Result<f32, Error>

See: CONTENT_THRESHOLD_PROPERTY

pub fn set_content_threshold(&self, value: f32) -> Result<(), Error>

See: CONTENT_THRESHOLD_PROPERTY

pub fn get_content_gradient(&self) -> Result<Vector2, Error>

See: CONTENT_GRADIENT_PROPERTY

pub fn set_content_gradient(&self, value: Vector2) -> Result<(), Error>

See: CONTENT_GRADIENT_PROPERTY

pub fn get_invert_content_mask(&self) -> Result<bool, Error>

See: INVERT_CONTENT_MASK_PROPERTY

pub fn set_invert_content_mask(&self, value: bool) -> Result<(), Error>

See: INVERT_CONTENT_MASK_PROPERTY

pub fn get_method(&self) -> Result<OutlineMethod, Error>

See: METHOD_PROPERTY

pub fn set_method(&self, value: OutlineMethod) -> Result<(), Error>

See: METHOD_PROPERTY

Methods from Deref<Target = NodeEffect2D>

pub fn get_enabled(&self) -> Result<bool, Error>

See: ENABLED_PROPERTY

pub fn set_enabled(&self, value: bool) -> Result<(), Error>

See: ENABLED_PROPERTY

Methods from Deref<Target = Resource>

pub fn get_name(&self) -> Result<KanziString, Error>

Gets the resource name.

pub fn get_url(&self) -> Result<KanziString, Error>

Gets the resource URL. Note that the URL is not necessarily in URL form if resource has been just created.

Returns

URL string.

pub fn set_keep_alive(&self, keep_alive: bool) -> Result<(), Error>

Sets the keep alive flag. Can be set only before the resource is registered to the resource manager. Normally set by loadFromKZB.

Arguments

• keep_alive - Value for the keep alive flag.

Methods from Deref<Target = Object>

pub fn as_ptr(&self) -> *mut ObjectWrapper

pub fn as_wrapper(&self) -> &ObjectWrapper

pub fn as_object(&self) -> &Object

Represents any type inheriting from Object as &Object. This is useful for comparisions when PartialEq traits failed to compare objects of different types.

let child = screen.get_child(0)?;
let parent = child.get_parent()?.into_error(ErrorKind::ObjectNotFound)?;
// assert_eq!(screen, parent); // <- Fails to compile!
assert_eq!(screen.as_object(), parent.as_object());

pub fn get_native(&self) -> Result<NonNull<c_void>, Error>

Gets a pointer to the backing C++ instance.

pub fn is_stale(&self) -> bool

Checks whether the weak reference has expired.

pub fn get_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<<T as VariantConstraint>::RetArg, Error>

where T: PropertyTypeConstraint,

Returns the current value of a property disregarding modifiers.

Base value is affected by the following inputs where the highest entry in the list determines the base value:

1. Local value set with setProperty or loaded from kzb
2. Value set by a style affecting the property.
3. Value defined by class metadata.

Modifiers are not applied, the highest-priority base value is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

Arguments

• property_type - The property type identifying the property to retrieve.

Returns

The evaluated property value.

pub fn get_optional_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<Option<<T as VariantConstraint>::RetArg>, Error>

where T: PropertyTypeConstraint,

Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

If there is no value sources, None is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

Arguments

• property_type - The property type identifying the property to retrieve.

Returns

The evaluated property value.

pub fn set_property<T>( &self, property_type: &PropertyType<T>, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Sets the local value of a property type.

pub fn has_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<bool, Error>

where T: PropertyTypeConstraint,

Evaluates whether there are any inputs into the property value. Both value sources and modifiers are taken into account.

Returns

Returns true if there are inputs into the property value, false otherwise.

pub fn remove_local_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Removes the local value associated with the property.

pub fn get_metaclass(&self) -> Result<Metaclass, Error>

Returns the metaclass of the dynamic type of the object.

pub fn get_domain(&self) -> Result<Domain, Error>

Returns the domain the object belongs to.

pub fn set_flag_keep_during_patching<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Sets the flag to indicate that the property was loaded from KZB.

pub fn debug_string(&self) -> Result<String, Error>

Builds a string representation of the object intended for debugging purposes.

Trait Implementations

impl Clone for OutlineEffect2D

fn clone(&self) -> OutlineEffect2D

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConcreteObjectConstraint for OutlineEffect2D

fn create_instance( domain: &Domain, name: impl AsRef<KanziStr>, ) -> Result<Self, Error>

impl Debug for OutlineEffect2D

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for OutlineEffect2D

type Target = NodeEffect2D

The resulting type after dereferencing.

fn deref(&self) -> &<OutlineEffect2D as Deref>::Target

Dereferences the value.

impl Inheritable for OutlineEffect2D

unsafe fn downcast_unchecked<T>(self) -> T

where T: Inherits<Self>,

Downcast the object to a more specific type.

unsafe fn downcast_unchecked_ref<T>(&self) -> &T

where T: Inherits<Self>,

Downcast the object reference to a more specific type.

impl Inherits<NodeEffect2D> for OutlineEffect2D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for OutlineEffect2D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Resource> for OutlineEffect2D

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl MetaclassConstraint for OutlineEffect2D

fn get_static_metaclass() -> &'static Metaclass

Gets metaclass associated with a given type.

impl ObjectConstraint for OutlineEffect2D

fn downcast<T>(self) -> Result<Option<T>, Error>

where T: MetaInherits<Self>,

Casts metaclass to a more specific type by value.

fn downcast_ref<T>(&self) -> Result<Option<&T>, Error>

where T: MetaInherits<Self>,

Casts metaclass to a more specific type by reference.

fn is_a<T>(&self) -> Result<bool, Error>

where T: MetaInherits<Self>,

Determines whether the class this metaclass describes derives from a class described by specified metaclass.

fn downgrade(self) -> Weak<Self>

fn downgrade_ref(&self) -> Weak<Self>

fn lock(self) -> ThreadObject<Self>

fn lock_ref(&self) -> ThreadObject<Self>

impl<T> PartialEq<T> for OutlineEffect2D

where T: ObjectConstraint,

fn eq(&self, rhs: &T) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialEq<Weak<T>> for OutlineEffect2D

where T: ObjectConstraint,

fn eq(&self, rhs: &Weak<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for OutlineEffect2D