Struct AnnotationFeatureTag 

pub struct AnnotationFeatureTag {
    pub entity_id: Option<Uuid>,
    pub edge_reference: Option<EdgeSpecifier>,
    pub entity_pos: Point2d<f64>,
    pub leader_type: AnnotationLineEnd,
    pub key: String,
    pub value: String,
    pub show_key: bool,
    pub plane_id: Uuid,
    pub offset: Point2d<f64>,
    pub font_scale: f32,
    pub font_point_size: u32,
    pub leader_scale: f32,
}

Parameters for defining an MBD Feature Tag Annotation state

Fields

entity_id: Option<Uuid>

Entity to place the annotation leader from

edge_reference: Option<EdgeSpecifier>

Edge reference to use to place the annotation leader from If both entity_id and edge_reference are provided, edge_reference takes precedence.

entity_pos: Point2d<f64>

Normalized position within the entity to position the annotation leader from

leader_type: AnnotationLineEnd

Type of leader to use

key: String

Tag key

value: String

Tag value

show_key: bool

Whether or not to display the key on the annotation label

plane_id: Uuid

Orientation plane. The annotation will lie in this plane which is positioned about the leader position as its origin.

offset: Point2d<f64>

2D Position offset of the annotation within the plane.

font_scale: f32

The scale of the font label in 3D space

font_point_size: u32

The point size of the fonts used to generate the annotation label. Very large values can negatively affect performance.

leader_scale: f32

The scale of the leader (dot or arrow). Defaults to 1.

Implementations

impl AnnotationFeatureTag

pub fn builder() -> AnnotationFeatureTagBuilder

Create an instance of AnnotationFeatureTag using the builder syntax

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for AnnotationFeatureTag

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for AnnotationFeatureTag

fn clone(&self) -> AnnotationFeatureTag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnnotationFeatureTag

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AnnotationFeatureTag

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for AnnotationFeatureTag

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for AnnotationFeatureTag

fn eq(&self, other: &AnnotationFeatureTag) -> 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 Serialize for AnnotationFeatureTag

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AnnotationFeatureTag

impl TS for AnnotationFeatureTag

type WithoutGenerics = AnnotationFeatureTag

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = AnnotationFeatureTag

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.