ModelSimplifyFlags

Description

[Flags]
enum Tinman.Engine.Models.ModelSimplifyFlags

Flags for choosing action for simplifying models.

When the ProcessThis flag is present, these actions are performed for each Model, in the order given:

RemoveEmptyParts
RemoveRedundant
SortParts
MergeParts
ReplaceEquivalent
IModel.Simplify (for each child model)
RemoveEmptyChildren
SortChildren

Then, the child models are processed if ProcessChildren is present. If ProcessRecursively is present, the ProcessChildren flag will be retained, otherwise it will be dropped.

See also: IModel.Simplify

Public / Constants

None

public constant None → (0:int32)

No simplification actions.

RemoveRedundant

public constant RemoveRedundant → (1:int32)

Removes redundant information from models and parts.

The following information is removed if redundant:

Parent-child relationships between two IModel objects which can be replaced with a single IModel node without causing a behavioural change in the model hierarchy. A change of the IModel.Name property from null to a non-empty name is allowed, though.
Redundant model part flags, as described by ModelPartFlags.
IMaterial.LineThickness is set to 1, if PrimitiveBatch.IsLines of IModelPart.Batch returns false.
Clear IMaterial.BaseColor of IModelPart.Material to ColorF.Black, if ColorF.A of IMaterial.BaseColor.MaterialPart.Value is almost equal to 0 and IModelPart.Flags does not contain ModelPartFlags.Opaque.
Set IMaterialPart.Channel of IModelPart.Material to 0 if IMaterialPart.Map is null or if the material part is multi-channel.

See also: MaterialPart.Clear²

RemoveEmptyParts

public constant RemoveEmptyParts → (2:int32)

Remove empty model parts.

A model part is considered empty in any of these cases:

PrimitiveBatch.Count of IModelPart.Batch is zero.
IModelPart.Geometry is null.
PrimitiveBatch.Indexed of IModelPart.Batch is true and IModelGeometry.IndexCount of IModelPart.Geometry is zero.
IModelGeometry.VertexCount of IModelPart.Geometry is zero.

See also: ModelSimplifyFlags.ProcessThis

RemoveEmptyChildren

public constant RemoveEmptyChildren → (4:int32)

Remove empty child models.

A child model is considered empty in any of these cases:

IModel.ChildCount is zero and IModel.PartCount is zero.

ReplaceEquivalent

public constant ReplaceEquivalent → (8:int32)

Replace different IModelPart, IModelGeometry, IModelTexture and IMaterial objects that are equivalent with the first object that has been encountered?

SortParts

public constant SortParts → (16:int32)

Sorts the model parts, so that mergeable parts become arranged sequentially.

See also: ModelSimplifyFlags.MergeParts

SortChildren

public constant SortChildren → (32:int32)

Sorts the child nodes: by name (ascending), then by part count (descending), then by child count (descending).

MergeParts

public constant MergeParts → (64:int32)

Merge subsequent model parts, if possible?

The IModelPart.Merge method is used for merging subsequent model parts.

See also: ModelSimplifyFlags.SortParts

ProcessThis

public constant ProcessThis → (128:int32)

Simplify the model on which IModel.Simplify is called?

ProcessChildren

public constant ProcessChildren → (256:int32)

Simplify the children of the model on which IModel.Simplify is called?

ProcessRecursively

public constant ProcessRecursively → (512:int32)

Simplify the descendants of the model on which IModel.Simplify is called?

If ProcessChildren is not present, this flag will be ignored.

All

public constant All → (1023:int32)

All simplification actions.