ThreeDLoadOptions

ThreeDLoadOptions class

Options for loading 3D documents.

public class ThreeDLoadOptions : LoadOptions, IResourceLoadingOptions

Constructors

Name Description
ThreeDLoadOptions() Initializes new instance of ThreeDLoadOptions class.

Properties

Name Description
ExternalResourceHandler { get; set; } Gets or sets the handler called for each dependency the 3D document loads, also while it is saved. Default: null.
Format { get; set; } Input document file type. Is null until a format has been set, so test it for null rather than against Unknown, which it never equals.
virtual Format { get; } Input document file type.
SkipExternalResources { get; set; } Gets or sets whether external resources are denied. Default: true.
WhitelistedResources { get; set; } Gets or sets the absolute URI prefixes of the external resources that load while SkipExternalResources is true.

Methods

Name Description
override Equals(object) Determines whether two object instances are equal.
virtual Equals(ValueObject) Determines whether two object instances are equal.
override GetHashCode() Serves as the default hash function.

Remarks

A 3D document can depend on other files: material libraries, textures and external buffers. These dependencies are always read as local files. Remote dependencies never load, even when SkipExternalResources is false, so an entry of WhitelistedResources takes effect only as a file: prefix, such as file:///D:/models/materials/.

A dependency that is not allowed is treated as missing. A model that cannot load without it, such as a glTF file whose external buffer is denied, fails to load.

See Also