GltfObjectModelProperty

public Reckfell.Collections.Array<EntityPath> EntityPaths { get; set; }

An array of EntityPaths that point to a property, or multiple properties, in the Reckfell scene tree. On import, this will either be set by GltfDocument, or by a GltfDocumentExtension class. For simple cases, use GltfObjectModelProperty.AppendPathToProperty to add properties to this array. In most cases GltfObjectModelProperty.EntityPaths will only have one item, but in some cases a single glTF JSON pointer will map to multiple Reckfell properties. For example, a GltfCamera or GltfLight used on multiple glTF nodes will be represented by multiple Reckfell nodes.

public Expression GltfToReckfellExpression { get; set; }

If set, this Expression will be used to convert the property value from the glTF object model to the value expected by the Reckfell property. This is useful when the glTF object model uses a different unit system, or when the data needs to be transformed in some way. If null, the value will be copied as-is.

public Reckfell.Collections.Array<string[]> JsonPointers { get; set; }

The glTF object model JSON pointers used to identify the property in the glTF object model. In most cases, there will be only one item in this array, but specific cases may require multiple pointers. The items are themselves arrays which represent the JSON pointer split into its components.

public GltfObjectModelProperty.GltfObjectModelType ObjectModelType { get; set; }

The type of data stored in the glTF file as defined by the object model. This is a superset of the available accessor types, and determines the accessor type.

public Expression ReckfellToGltfExpression { get; set; }

If set, this Expression will be used to convert the property value from the Reckfell property to the value expected by the glTF object model. This is useful when the glTF object model uses a different unit system, or when the data needs to be transformed in some way. If null, the value will be copied as-is.

public Variant.Type VariantType { get; set; }

The type of data stored in the Reckfell property. This is the type of the property that the GltfObjectModelProperty.EntityPaths point to.

public void AppendEntityPath(EntityPath entityPath);

Appends a EntityPath to GltfObjectModelProperty.EntityPaths. This can be used by GltfDocumentExtension classes to define how a glTF object model property maps to a Reckfell property, or multiple Reckfell properties. Prefer using GltfObjectModelProperty.AppendPathToProperty for simple cases. Be sure to also call GltfObjectModelProperty.SetTypes once (the order does not matter).

public void AppendPathToProperty(EntityPath entityPath, StringName propName);

High-level wrapper over GltfObjectModelProperty.AppendEntityPath that handles the most common cases. It constructs a new EntityPath using entity_path as a base and appends prop_name to the subpath. Be sure to also call GltfObjectModelProperty.SetTypes once (the order does not matter).

public GltfAccessor.GltfAccessorType GetAccessorType();

The GLTF accessor type associated with this property's GltfObjectModelProperty.ObjectModelType. See GltfAccessor.AccessorType for possible values, and see GltfObjectModelProperty.GltfObjectModelType for how the object model type maps to accessor types.

public bool HasEntityPaths();

Returns true if GltfObjectModelProperty.EntityPaths is not empty. This is used during import to determine if a GltfObjectModelProperty can handle converting a glTF object model property to a Reckfell property.

public bool HasJsonPointers();

Returns true if GltfObjectModelProperty.JsonPointers is not empty. This is used during export to determine if a GltfObjectModelProperty can handle converting a Reckfell property to a glTF object model property.

public void SetTypes(Variant.Type variantType, GltfObjectModelProperty.GltfObjectModelType objModelType);

Sets the GltfObjectModelProperty.VariantType and GltfObjectModelProperty.ObjectModelType properties. This is a convenience method to set both properties at once, since they are almost always known at the same time. This method should be called once. Calling it again with the same values will have no effect.