ModelPose

Description

sealed class Tinman.Engine.Models.ModelPose

Derived from: Versioned ^abstract

A model pose modifies an existing hierarchy of IModel objects.

Public / Methods

Apply

public method Apply → (2)

model ⁱⁿ : IModel: [not-null]
The model.
update ⁱⁿ : ModelPoseDelegate: [not-null]
The model pose update.

Performs a recursive model pose update.

Clear

_2 overloads

public method Clear¹ → ()

Clears all model poses.

public method Clear² → (2)

model ⁱⁿ : IModel: [not-null]
The model.
recursive ^opt : bool = false: Clear pose for descendant models, too?

Clears the pose of the given model.

Flags

_2 overloads

[Pure]
public method Flags¹ → (1)

model ⁱⁿ : IModel: [not-null]
The model.
returns → ModelPoseFlags: The model pose flags.

Returns the pose flags of the given model.

public method Flags² → (4)

model ⁱⁿ : IModel: [not-null]
The model.
flags ⁱⁿ : ModelPoseFlags: The pose flags.
op ^opt : int32 = 0: The update operation:
< 0 : Remove flags ⁱⁿ.
> 0 : Add flags ⁱⁿ.
= 0 : Set flags ⁱⁿ.
recursive ^opt : bool = false: Update pose flags for descendant models, too?

Updates the pose flags for the given model.

See also: ModelPoseFlags.NonRecursive

Material

_4 overloads

[Pure]
public method Material¹ → (1)

model ⁱⁿ : IModel: [not-null]
The model.
returns → IMaterial: The custom material or null.

Returns the custom material of the given model.

[Pure]
public method Material² → (1)

part ⁱⁿ : IModelPart: [not-null]
The model part.
returns → IMaterial: The custom material or null.

Returns the custom material of the given model part.

public method Material³ → (3)

model ⁱⁿ : IModel: [not-null]
The model.
material ⁱⁿ : IMaterial: The material or null.
recursive ^opt : bool = false: Set material for descendant models, too?

Sets the custom material for the given model.

Settings a custom material for a model will clear the custom materials of its model parts.

See also: ModelPoseFlags.MaterialSolid
ModelPoseFlags.MaterialOpaque
ModelPoseFlags.MaterialTransparent

public method Material⁴ → (2)

part ⁱⁿ : IModelPart: [not-null]
The model part.
material ⁱⁿ : IMaterial: The material or null to use IModelPart.Material.

Sets the custom material for the given model part.

See also: ModelPoseFlags.MaterialSolid
ModelPoseFlags.MaterialOpaque
ModelPoseFlags.MaterialTransparent

Select

_2 overloads

[Pure]
public method Select¹ → (1)

model ⁱⁿ : IModel: [not-null]
The group model.
returns → int32: Index of the selected child of model ⁱⁿ or -1 if none.

Returns the selected child of the given group model.

public method Select² → (2)

model ⁱⁿ : IModel: [not-null]
The group model.
child ⁱⁿ : int32: Index of the child to select or negative to clear the current selection, if any.

Selects a child of a group model for rendering.

See also: ModelFlags.Group

Transform

_2 overloads

[Pure]
public method Transform¹ → (1)

model ⁱⁿ : IModel: [not-null]
The model.
returns → AffineTransform: The custom transformation matrix.

Returns the custom transformation of the given model.

The custom transformation is applied after the animation keyframe transform (if present) and before the child-to-parent transform of the parent model (if existent).

public method Transform² → (2)

model ⁱⁿ : IModel: [not-null]
The model.
transform ⁱⁿ : AffineTransform: The custom transformation to apply (see remarks).

Sets the custom transformation for the given model.

The custom transformation is applied after the animation keyframe transform (if present) and before the child-to-parent transform of the parent model (if existent).