Struct vtubestudio::data::ModelOutlineEvent

pub struct ModelOutlineEvent {
    pub model_name: String,
    pub model_id: String,
    pub convex_hull: Vec<Vec2>,
    pub convex_hull_center: Vec2,
    pub window_size: Vec2,
}

An event that is triggered at a constant 15 FPS and sends subscribed plugins the model outline.

Specifically, it sends an approximated convex polygon based on the bounding-box center points of all (visible) ArtMeshes in the model. If no model is loaded, the event isn’t sent.

This event can be configured using ModelOutlineEventConfig.

Fields

model_name: String

Model name. E.g., "My VTS Model Name".

model_id: String

Model ID. E.g., "165131471d8a4e42aae01a9738f255ef".

convex_hull: Vec<Vec2>

2D points describing the rough outline of the model.

This list is ordered. The x/y coordinate of each point is its position within the VTube Studio window. X or Y coordinates may be bigger than 1 or smaller than -1 if an outline point is outside of the window boundaries.

The convex_hull list is guaranteed to have at least 3 entries. There is no limit to how many entries it can have, but for most normal Live2D models, it has between 5 and 25 entries. Please also keep in mind that the number of list entries can (and will most likely) change between events you receive. Do not implement your plugin expecting the number of outline points to remain constant.

convex_hull_center: Vec2

The center/average of all the convex_hull points.

window_size: Vec2

The current VTube Studio window size.

Trait Implementations

impl Clone for ModelOutlineEvent

fn clone(&self) -> ModelOutlineEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModelOutlineEvent

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

Formats the value using the given formatter.

impl Default for ModelOutlineEvent

fn default() -> ModelOutlineEvent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModelOutlineEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventData for ModelOutlineEvent

type Config = ModelOutlineEventConfig

ModelOutlineEventConfig

impl PartialEq<ModelOutlineEvent> for ModelOutlineEvent

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Response for ModelOutlineEvent

const MESSAGE_TYPE: EnumString<ResponseType> = _

ResponseType::ModelOutlineEvent

impl Serialize for ModelOutlineEvent

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 ModelOutlineEvent