GltfState

public double BakeFps { get; set; }

The baking fps of the animation for either import or export.

public string BasePath { get; set; }

The folder path associated with this glTF data. This is used to find other files the glTF file references, like images or binary buffers. This will be set during import when appending from a file, and will be set during export when writing to a file.

public string Copyright { get; set; }

The copyright string in the asset header of the glTF file. This is set during import if present and export if non-empty. See the glTF asset header documentation for more information.

public string FileName { get; set; }

The file name associated with this glTF data. If it ends with .gltf, this is text-based glTF, otherwise this is binary GLB. This will be set during import when appending from a file, and will be set during export when writing to a file. If writing to a buffer, this will be an empty string.

public byte[] GlbData { get; set; }

The binary buffer attached to a .glb file.

public GltfState.HandleBinaryImageModeEnum HandleBinaryImageMode { get; set; }

When importing a glTF file with unimported raw binary images embedded inside of binary blob buffers, in data URIs, or separate files not imported by Reckfell, this controls how the images are handled. Images can be discarded, saved as separate files, or embedded in the scene lossily or losslessly. See GltfState.HandleBinaryImageModeEnum for options. This property does nothing for image files in the asset:// folder imported by Reckfell, as those are handled by Reckfell's image importer directly, and then the Reckfell scene generated from the glTF file will use the images as Reckfell imported them.

public bool ImportAsSkeletonBones { get; set; }

If true, forces all GLTFNodes in the document to be bones of a single Skeleton3D Reckfell node.

public Reckfell.Collections.Dictionary Json { get; set; }

The original raw JSON document corresponding to this GLTFState.

public int[] RootNodes { get; set; }

The root nodes of the glTF file. Typically, a glTF file will only have one scene, and therefore one root node. However, a glTF file may have multiple scenes and therefore multiple root nodes, which will be generated as siblings of each other and as children of the root node of the generated Reckfell scene.

public string SceneName { get; set; }

The name of the scene. When importing, if not specified, this will be the file name. When exporting, if specified, the scene name will be saved to the glTF file.

public void AddUsedExtension(string extensionName, bool required);

Appends an extension to the list of extensions used by this glTF file during serialization. If required is true, the extension will also be added to the list of required extensions. Do not run this in GltfDocumentExtension._ExportPost, as that stage is too late to add extensions. The final list is sorted alphabetically.

public int AppendDataToBuffers(byte[] data, bool deduplication);

Appends the given byte array data to the buffers and creates a GltfBufferView for it. The index of the destination GltfBufferView is returned. If deduplication is true, the buffers are first searched for duplicate data, otherwise new bytes are always appended.

public int AppendDataToBuffers(ReadOnlySpan<byte> data, bool deduplication);

Appends the given byte array data to the buffers and creates a GltfBufferView for it. The index of the destination GltfBufferView is returned. If deduplication is true, the buffers are first searched for duplicate data, otherwise new bytes are always appended.

public int AppendGltfNode(GltfNode gltfNode, Entity reckfellSceneNode, int parentNodeIndex);

Appends the given GltfNode to the state, and returns its new index. This can be used to export one Reckfell node as multiple glTF nodes, or inject new glTF nodes at import time. On import, this must be called before GltfDocumentExtension._GenerateSceneNode finishes for the parent node. On export, this must be called before GltfDocumentExtension._ExportNode runs for the parent node. The reckfell_scene_node parameter is the Reckfell scene node that corresponds to this glTF node. This is highly recommended to be set to a valid node, but may be null if there is no corresponding Reckfell scene node. One Reckfell scene node may be used for multiple glTF nodes, so if exporting multiple glTF nodes for one Reckfell scene node, use the same Reckfell scene node for each. The parent_node_index parameter is the index of the parent GltfNode in the state. If -1, the node will be a root node, otherwise the new node will be added to the parent's list of children. The index will also be written to the GltfNode.Parent property of the new node.

public Variant GetAdditionalData(StringName extensionName);

Gets additional arbitrary data in this GltfState instance. This can be used to keep per-file state data in GltfDocumentExtension classes, which is important because they are stateless. The argument should be the GltfDocumentExtension name (does not have to match the extension name in the glTF file), and the return value can be anything you set. If nothing was set, the return value is null.

public AnimationPlayer GetAnimationPlayer(int animPlayerIndex);

Returns the AnimationPlayer node with the given index. These nodes are only used during the export process when converting Reckfell AnimationPlayer nodes to glTF animations.

public int GetAnimationPlayersCount(int animPlayerIndex);

Returns the number of AnimationPlayer nodes in this GltfState. These nodes are only used during the export process when converting Reckfell AnimationPlayer nodes to glTF animations.

public Reckfell.Collections.Array<GltfAnimation> GetAnimations();

Returns an array of all GltfAnimations in the glTF file. When importing, these will be generated as animations in an AnimationPlayer node. When exporting, these will be generated from Reckfell AnimationPlayer nodes.

public Reckfell.Collections.Array<GltfCamera> GetCameras();

Returns an array of all GltfCameras in the glTF file. These are the cameras that the GltfNode.Camera index refers to.

public int GetEntityIndex(Entity sceneNode);

Returns the index of the GltfNode corresponding to this Reckfell scene node. This is the inverse of GltfState.GetSceneNode. Useful during the export process. Note: Not every Reckfell scene node will have a corresponding GltfNode, and not every GltfNode will have a scene node generated. If there is no GltfNode index for this scene node, -1 is returned.

public int GetHandleBinaryImage();

Deprecated untyped alias for GltfState.HandleBinaryImageMode. When importing a glTF file with unimported raw binary images embedded inside of binary blob buffers, in data URIs, or separate files not imported by Reckfell, this controls how the images are handled.

public Reckfell.Collections.Array<Texture2D> GetImages();

Gets the images of the glTF file as an array of Texture2Ds. These are the images that the GltfTexture.SrcImage index refers to.

public Reckfell.Collections.Array<GltfLight> GetLights();

Returns an array of all GltfLights in the glTF file. These are the lights that the GltfNode.Light index refers to.

public Reckfell.Collections.Array<GltfMesh> GetMeshes();

Returns an array of all GltfMeshes in the glTF file. These are the meshes that the GltfNode.Mesh index refers to.

public Reckfell.Collections.Array<GltfNode> GetNodes();

Returns an array of all GltfNodes in the glTF file. These are the nodes that GltfNode.Children and GltfState.RootNodes refer to. This includes nodes that may not be generated in the Reckfell scene, or nodes that may generate multiple Reckfell scene nodes.

public Entity GetSceneNode(int gltfNodeIndex);

Returns the Reckfell scene node that corresponds to the same index as the GltfNode it was generated from. This is the inverse of GltfState.GetEntityIndex. Useful during the import process. Note: Not every GltfNode will have a scene node generated, and not every generated scene node will have a corresponding GltfNode. If there is no scene node for this GltfNode index, null is returned.

public Reckfell.Collections.Array<GltfSkeleton> GetSkeletons();

Returns an array of all GltfSkeletons in the glTF file. These are the skeletons that the GltfNode.Skeleton index refers to.

public Reckfell.Collections.Array<GltfSkin> GetSkins();

Returns an array of all GltfSkins in the glTF file. These are the skins that the GltfNode.Skin index refers to.

public Reckfell.Collections.Array<GltfTextureSampler> GetTextureSamplers();

Retrieves the array of texture samplers that are used by the textures contained in the glTF.

public Reckfell.Collections.Array<string> GetUniqueAnimationNames();

Returns an array of unique animation names. This is only used during the import process.

public Reckfell.Collections.Array<string> GetUniqueNames();

Returns an array of unique node names. This is used in both the import process and export process.

public void SetAdditionalData(StringName extensionName, Variant additionalData);

Sets additional arbitrary data in this GltfState instance. This can be used to keep per-file state data in GltfDocumentExtension classes, which is important because they are stateless. The first argument should be the GltfDocumentExtension name (does not have to match the extension name in the glTF file), and the second argument can be anything you want.

public void SetAnimations(Reckfell.Collections.Array<GltfAnimation> animations);

Sets the GltfAnimations in the state. When importing, these will be generated as animations in an AnimationPlayer node. When exporting, these will be generated from Reckfell AnimationPlayer nodes.

public void SetCameras(Reckfell.Collections.Array<GltfCamera> cameras);

Sets the GltfCameras in the state. These are the cameras that the GltfNode.Camera index refers to.

public void SetHandleBinaryImage(int method);

Deprecated untyped alias for GltfState.HandleBinaryImageMode. When importing a glTF file with unimported raw binary images embedded inside of binary blob buffers, in data URIs, or separate files not imported by Reckfell, this controls how the images are handled.

public void SetImages(Reckfell.Collections.Array<Texture2D> images);

Sets the images in the state stored as an array of Texture2Ds. This can be used during export. These are the images that the GltfTexture.SrcImage index refers to.

public void SetLights(Reckfell.Collections.Array<GltfLight> lights);

Sets the GltfLights in the state. These are the lights that the GltfNode.Light index refers to.

public void SetMeshes(Reckfell.Collections.Array<GltfMesh> meshes);

Sets the GltfMeshes in the state. These are the meshes that the GltfNode.Mesh index refers to.

public void SetNodes(Reckfell.Collections.Array<GltfNode> nodes);

Sets the GltfNodes in the state. These are the nodes that GltfNode.Children and GltfState.RootNodes refer to. Some of the nodes set here may not be generated in the Reckfell scene, or may generate multiple Reckfell scene nodes.

public void SetSkeletons(Reckfell.Collections.Array<GltfSkeleton> skeletons);

Sets the GltfSkeletons in the state. These are the skeletons that the GltfNode.Skeleton index refers to.

public void SetSkins(Reckfell.Collections.Array<GltfSkin> skins);

Sets the GltfSkins in the state. These are the skins that the GltfNode.Skin index refers to.

public void SetTextureSamplers(Reckfell.Collections.Array<GltfTextureSampler> textureSamplers);

Sets the array of texture samplers that are used by the textures contained in the glTF.

public void SetUniqueAnimationNames(Reckfell.Collections.Array<string> uniqueAnimationNames);

Sets the unique animation names in the state. This is only used during the import process.

public void SetUniqueNames(Reckfell.Collections.Array<string> uniqueNames);

Sets the unique node names in the state. This is used in both the import process and export process.

public const long HandleBinaryDiscardTextures = 0;

Discards all embedded textures and uses untextured materials.

public const long HandleBinaryEmbedAsBasisu = 2;

Embeds textures VRAM compressed with Basis Universal into the generated scene.

public const long HandleBinaryEmbedAsUncompressed = 3;

Embeds textures compressed losslessly into the generated scene, matching old behavior.

public const long HandleBinaryExtractTextures = 1;

Extracts embedded textures to be reimported and compressed. Editor only. Acts as uncompressed at runtime.