Skip to main content

EdgeKind

Enum EdgeKind 

Source
#[non_exhaustive]
pub enum EdgeKind {
Show 21 variants SceneMember, AttributeBinding, SurfaceShader, DisplacementShader, VolumeShader, LensShader, BackgroundLayer, Bounds, SubsurfaceSet, ExclusiveShading, FaceSet, Weld, Other { to_attribute: String, }, InstanceSource, SetMember, LightSet, ShaderAttributes, Screen, OutputLayer, OutputDriver, ShaderNetwork { from_port: String, to_port: String, },
}
Expand description

What an ɴsɪ connection means, once classified.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

SceneMember

X -> .root "objects", or a transform chain link. Membership and hierarchy share one ɴsɪ attribute; which one an edge is depends on whether the destination is .root, so the recorder resolves that when it walks the graph rather than here.

§

AttributeBinding

attributes -> geo "geometryattributes". The attributes node has no counterpart in either target renderer and is dissolved at flush time.

§

SurfaceShader

shader -> attributes "surfaceshader". Becomes the shape’s material.

§

DisplacementShader

shader -> attributes "displacementshader".

§

VolumeShader

shader -> attributes "volumeshader".

§

LensShader

shader -> camera "lensshader". ɴsɪ: “a lens shader is an osl network connected to a camera through the lensshader connection”.

§

BackgroundLayer

outputlayer -> outputlayer "backgroundlayer".

§

Bounds

geometry -> attributes "bounds".

§

SubsurfaceSet

set -> attributes "visibility.set.subsurface".

§

ExclusiveShading

set -> .global "exclusiveshading".

§

FaceSet

set -> geometry "facesets". ɴsɪ’s own Listing 3.2.

§

Weld

weld -> geometry "weld". The geometry’s weld.* table declares boundary uses in that weld node’s namespace; see Scene::weld_table.

§

Other

A connection to some other attribute, carried but never interpreted.

ɴsɪ permits connecting a node to an arbitrary attribute – the specification’s own §4.8 connects one attributes node to another’s visibility with a "value" argument – so the set of legal destinations is open and cannot be enumerated. Rejecting what is not listed made legal scenes unrecordable; interpreting it would be the guess this module exists to refuse. So it is kept, with its name, and resolution ignores it.

Fields

§to_attribute: String

The destination attribute, verbatim.

§

InstanceSource

geo -> instances "sourcemodels".

§

SetMember

node -> set "members". A set node groups nodes so one connection stands for many.

§

LightSet

set -> outputlayer "lightset". ɴsɪ’s documented light-set workflow connects lights to a set, then the set here.

§

ShaderAttributes

shaderattributes -> geometry|transform "shaderattributes".

§

Screen

screen -> camera "screens".

§

OutputLayer

outputlayer -> screen "outputlayers".

§

OutputDriver

outputdriver -> outputlayer "outputdrivers".

§

ShaderNetwork

An attribute-to-attribute shader network edge, naming ports on both ends.

This maps 1:1 onto OSL’s ConnectShaders, which is unsurprising: ɴsɪ was designed around OSL. Renderers whose references point at whole objects rather than attributes need an adapter here.

Fields

§from_port: String

The output port named on the source node.

§to_port: String

The input port named on the destination node.

Implementations§

Source§

impl EdgeKind

Source

pub fn to_attribute(&self) -> &str

The ɴsɪ destination attribute this class came from.

Inverse of classify for every class but EdgeKind::ShaderNetwork, whose destination is a port name the caller already holds. The two must change together.

Trait Implementations§

Source§

impl Clone for EdgeKind

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EdgeKind

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for EdgeKind

Source§

impl Hash for EdgeKind

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for EdgeKind

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for EdgeKind

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.