Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
pluginbase.Objects.Models.IModelInstance Interface Reference

An interface that represents a model Instance An instance is a readonly model with extra data specific to an instance This model has not been instantiated in the world More...

Public Member Functions

void QueueAnimation (ModelAnimation mode, bool interrupt)
 Queue an animation, to be played More...
 
void QueueAnimation (ModelAnimation mode)
 Queue animation to be played when other animations have finished More...
 
void QueueAnimation (string slug, bool interrupt)
 Queue animation, by name, to be played More...
 
void QueueAnimation (string slug)
 Queue animation, by name, to be played More...
 
bool IsGroupVisible (string groupName)
 Determines whether or not a group, by name, is visible More...
 
void SetGroupVisibility (string groupName, bool visible)
 Sets a group names visibility More...
 
void SetAllVisibility (bool visible)
 Sets all visibility of all groups in the model More...
 
Matrix4 GetFinalTransform ()
 Gets the final computed transform, after both the instance matrix, and the model's matrix, have been applied More...
 

Properties

IReadonlyModel Model [get]
 The reference to the model the instances is of More...
 
ModelAnimation CurrentAnimation [get]
 The current animation the instance is playing, if any More...
 
float CurrentFrame [get]
 The current frame the instance is playing, if any More...
 
bool[] VisibleGroupMap [get]
 Gets the visible group map. More...
 
Matrix4 Transform [get, set]
 An instance-level model transformation matrix More...
 
AxisAlignedBox CurrentBoundingBox [get]
 Get the current bounding box, after transforms have been applied. Uses the current animated frame More...
 

Events

Action< IModelInstanceOnAnimationComplete
 Occurs when animation completes. More...
 

Detailed Description

An interface that represents a model Instance An instance is a readonly model with extra data specific to an instance This model has not been instantiated in the world

Member Function Documentation

Matrix4 pluginbase.Objects.Models.IModelInstance.GetFinalTransform ( )

Gets the final computed transform, after both the instance matrix, and the model's matrix, have been applied

Returns
The final transform.
bool pluginbase.Objects.Models.IModelInstance.IsGroupVisible ( string  groupName)

Determines whether or not a group, by name, is visible

Returns
true if this instance is group visible the specified groupName; otherwise, false.
Parameters
groupNameGroup name.
void pluginbase.Objects.Models.IModelInstance.QueueAnimation ( ModelAnimation  mode,
bool  interrupt 
)

Queue an animation, to be played

Parameters
modeMode.
interruptIf set to true interrupt any current animation
void pluginbase.Objects.Models.IModelInstance.QueueAnimation ( ModelAnimation  mode)

Queue animation to be played when other animations have finished

Parameters
modeMode.
void pluginbase.Objects.Models.IModelInstance.QueueAnimation ( string  slug,
bool  interrupt 
)

Queue animation, by name, to be played

Parameters
slugSlug.
interruptIf set to true interrupt current animation
void pluginbase.Objects.Models.IModelInstance.QueueAnimation ( string  slug)

Queue animation, by name, to be played

Parameters
slugSlug.
void pluginbase.Objects.Models.IModelInstance.SetAllVisibility ( bool  visible)

Sets all visibility of all groups in the model

Parameters
visibleIf set to true visible.
void pluginbase.Objects.Models.IModelInstance.SetGroupVisibility ( string  groupName,
bool  visible 
)

Sets a group names visibility

Parameters
groupNameGroup name.
visibleIf set to true visible.

Property Documentation

ModelAnimation pluginbase.Objects.Models.IModelInstance.CurrentAnimation
get

The current animation the instance is playing, if any

The current animation.

AxisAlignedBox pluginbase.Objects.Models.IModelInstance.CurrentBoundingBox
get

Get the current bounding box, after transforms have been applied. Uses the current animated frame

The current bounding box.

float pluginbase.Objects.Models.IModelInstance.CurrentFrame
get

The current frame the instance is playing, if any

The current frame.

IReadonlyModel pluginbase.Objects.Models.IModelInstance.Model
get

The reference to the model the instances is of

The model.

Matrix4 pluginbase.Objects.Models.IModelInstance.Transform
getset

An instance-level model transformation matrix

The transform.

bool [] pluginbase.Objects.Models.IModelInstance.VisibleGroupMap
get

Gets the visible group map.

The visible group map.

Event Documentation

Action<IModelInstance> pluginbase.Objects.Models.IModelInstance.OnAnimationComplete

Occurs when animation completes.


The documentation for this interface was generated from the following file: