gltf

glTF(filename, *[, apply_normals])
export_scene(scene, *[, filename])	Generate gltf from FURY scene.
write_scene(gltf, nodes)	Create scene
write_node(gltf, *[, mesh_id, camera_id])	Create node
write_mesh(gltf, primitives)	Create mesh and add primitive.
write_camera(gltf, camera)	Create and add camera.
get_prim(vertex, index, color, tcoord, ...)	Return a Primitive object.
write_material(gltf, basecolortexture, uri)	Write Material, Images and Textures
write_accessor(gltf, bufferview, ...[, max, min])	Write accessor in the gltf.
write_bufferview(gltf, buffer, byte_offset, ...)	Write bufferview in the gltf.
write_buffer(gltf, byte_length, uri)	Write buffer int the gltf

glTF

class fury.gltf.glTF(filename, *, apply_normals=False)

Bases: object

actors()

Generate actors from glTF file.

Returns:

actorslist

List of vtkActors with texture.

apply_morph_vertices(vertices, weights, cnt)

Calculate weighted vertex from the morph data.

Parameters:

verticesndarray

Vertices of a actor.

weightsndarray

Morphing weights used to calculate the weighted average of new vertex.

cntint

Count of the actor.

apply_skin_matrix(vertices, joint_matrices, *, actor_index=0)

Apply the skinnig matrix, that transform the vertices.

Parameters:

verticesndarray

Vertices of an actor.

join_matriceslist

List of skinning matrix to calculate the weighted transformation.

Returns:

verticesndarray

Modified vertices.

generate_tmatrix(transf, prop)

Create transformation matrix from TRS array.

Parameters:

transfndarray

Array containing translation, rotation or scale values.

propstr

String that defines the type of array (values: translation, rotation or scale).

Returns:

matrixndarray (4, 4)

ransformation matrix of shape (4, 4) with respective transforms.

get_acc_data(acc_id)

Get the correct data from buffer using accessors and bufferviews.

Parameters:

acc_idint

Accessor index

Returns:

buffer_arrayndarray

Numpy array extracted from the buffer.

get_animations()

Return list of animations.

Returns:

animations: List

List of animations containing actors.

get_buff_array(buff_id, d_type, byte_length, byte_offset, byte_stride)

Extract the mesh data from buffer.

Parameters:

buff_idint

Buffer Index

d_typetype

Element data type

byte_lengthint

The length of the buffer data

byte_offsetint

The offset into the buffer in bytes

byte_strideint

The stride, in bytes

Returns:

out_arrndarray

Numpy array of size byte_length from buffer.

get_joint_actors(*, length=0.5, with_transforms=False)

Create an arrow actor for each bone in a skinned model.

Parameters:

lengthfloat (default = 0.5)

Length of the arrow actor

with_transformsbool (default = False)

Applies respective transformations to bone. Bones will be at origin if set to False.

get_materials(mat_id)

Get the material data.

Parameters:

mat_idint

Material index

Returns:

materialsdict

Dictionary of all textures.

get_matrix_from_sampler(prop, node, anim_channel, sampler: Sampler)

Return transformation matrix for a given timestamp from Sampler data. Combine matrices for a given common timestamp.

Parameters:

propstr

Property of the array (‘translation’, ‘rotation’ or ‘scale’)

nodeint

Node index of the sampler data.

anim_channeldict

Containing previous animations with node as keys.

samplergltflib.Sampler

Sampler object for an animation channel.

get_morph_data(target, mesh_id)

get_sampler_data(sampler: Sampler, node_id: int, transform_type)

Get the animation and transformation data from sampler.

Parameters:

samplerglTFlib.Sampler

pygltflib sampler object.

node_idint

Node index of the current animation channel.

transform_typestr

Property of the node to be transformed.

Returns:

sampler_datadict

dictionary of data containing timestamps, node transformations and interpolation type.

get_skin_data(skin_id)

Get the inverse bind matrix for each bone in the skin.

Parameters:

skin_idint

Index of the skin.

Returns:

joint_nodeslist

List of bones in the skin.

inv_bind_matrixndarray

Numpy array containing inverse bind pose for each bone.

get_texture(tex_id)

Read and convert image into vtk texture.

Parameters:

tex_idint

Texture index

Returns:

atextureTexture

Returns flipped vtk texture from image.

initialize_skin(animation, *, bones=False, length=0.2)

Create bones and add to the animation and initialise update_skin

Parameters:

animationAnimation

Skin animation object.

bonesbool

Switches the visibility of bones in scene. (default=False)

lengthfloat

Length of the bones. (default=0.2)

inspect_scene(*, scene_id=0)

Loop over nodes in a scene.

Parameters:

scene_idint, optional

scene index of the glTF.

load_camera(camera_id, transform_mat)

Load the camera data of a node.

Parameters:

camera_idint

Camera index of a node.

transform_matndarray (4, 4)

Transformation matrix of the camera.

load_mesh(mesh_id, transform_mat, parent)

Load the mesh data from accessor and applies the transformation.

Parameters:

mesh_idint

Mesh index to be loaded

transform_matndarray (4, 4)

Transformation matrix.

main_animation()

Return main animation with all glTF animations.

Returns:

main_animationAnimation

A parent animation containing all child animations for simple animation.

morph_animation()

Create animation for each channel in animations.

Returns:

root_animationsDict

A dictionary containing animations as values and animation name as keys.

skin_animation()

One animation for each bone, contains parent transforms.

Returns:

root_animationsDict

An animation containing all the child animations for bones.

transverse_animations(animation, bone_id, timestamp, joint_matrices, *, parent_bone_deform=None)

Calculate skinning matrix (Joint Matrices) and transform bone for each animation.

Parameters:

animationAnimation

Animation object.

bone_idint

Bone index of the current transform.

timestampfloat

Current timestamp of the animation.

joint_matricesdict

Empty dictionary that will contain joint matrices.

parent_bone_transformndarray (4, 4)

Transformation matrix of the parent bone. (default=np.identity(4))

transverse_bones(bone_id, channel_name, parent_animation: Animation)

Loop over the bones and add child bone animation to their parent animation.

Parameters:

bone_idint

Index of the bone.

channel_namestr

Animation name.

parent_animationAnimation

The animation of the parent bone. Should be root_animation by default.

transverse_channels(animation: Animation, count: int)

Loop over animation channels and sets animation data.

Parameters:

animationglTflib.Animation

pygltflib animation object.

countint

Animation count.

transverse_node(nextnode_id, matrix, *, parent=None, is_joint=False)

Load mesh and generates transformation matrix.

Parameters:

nextnode_idint

Index of the node

matrixndarray (4, 4)

Transformation matrix

parentlist, optional

List of indices of parent nodes Default: None.

is_jointBool

To determine if the current node is a joint/bone of skins. Default: False

update_morph(animation)

Update the animation and actors with morphing.

Parameters:

animationAnimation

Animation object.

update_skin(animation)

Update the animation and actors with skinning data.

Parameters:

animationAnimation

Animation object.

export_scene

fury.gltf.export_scene(scene, *, filename='default.gltf')

Generate gltf from FURY scene.

Parameters:

scene: Scene

FURY scene object.

filename: str, optional

Name of the model to be saved

write_scene

fury.gltf.write_scene(gltf, nodes)

Create scene

Parameters:

gltf: GLTF2

Pygltflib GLTF2 object

nodes: list

List of node indices.

write_node

fury.gltf.write_node(gltf, *, mesh_id=None, camera_id=None)

Create node

Parameters:

gltf: GLTF2

Pygltflib GLTF2 object

mesh_id: int, optional

Mesh index

camera_id: int, optional

Camera index.

write_mesh

fury.gltf.write_mesh(gltf, primitives)

Create mesh and add primitive.

Parameters:

gltf: GLTF2

Pygltflib GLTF2 object.

primitives: list

List of Primitive object.

write_camera

fury.gltf.write_camera(gltf, camera)

Create and add camera.

Parameters:

gltf: GLTF2

Pygltflib GLTF2 object.

camera: vtkCamera

scene camera.

get_prim

fury.gltf.get_prim(vertex, index, color, tcoord, normal, material, *, mode=4)

Return a Primitive object.

Parameters:

vertex: int

Accessor index for the vertices data.

index: int

Accessor index for the triangles data.

color: int

Accessor index for the colors data.

tcoord: int

Accessor index for the texture coordinates data.

normal: int

Accessor index for the normals data.

material: int

Materials index.

mode: int, optional

The topology type of primitives to render. Default: 4

Returns:

prim: Primitive

pygltflib primitive object.

write_material

fury.gltf.write_material(gltf, basecolortexture: int, uri: str)

Write Material, Images and Textures

Parameters:

gltf: GLTF2

Pygltflib GLTF2 object.

basecolortexture: int

BaseColorTexture index.

uri: str

BaseColorTexture uri.

write_accessor

fury.gltf.write_accessor(gltf, bufferview, byte_offset, comp_type, count, accssor_type, *, max=None, min=None)

Write accessor in the gltf.

Parameters:

gltf: GLTF2

Pygltflib GLTF2 objecomp_type

bufferview: int

BufferView Index

byte_offset: int

ByteOffset of the accessor

comp_type: type

Type of a single component

count: int

Elements count of the accessor

accssor_type: type

Type of the accessor(SCALAR, VEC2, VEC3, VEC4)

max: ndarray, optional

Maximum elements of an array

min: ndarray, optional

Minimum elements of an array

write_bufferview

fury.gltf.write_bufferview(gltf, buffer, byte_offset, byte_length, *, byte_stride=None)

Write bufferview in the gltf.

Parameters:

gltf: GLTF2

Pygltflib GLTF2 object

buffer: int

Buffer index

byte_offset: int

Byte offset of the bufferview

byte_length: int

Byte length ie, Length of the data we want to get from the buffer

byte_stride: int, optional

Byte stride of the bufferview.

write_buffer

fury.gltf.write_buffer(gltf, byte_length, uri)

Write buffer int the gltf

Parameters:

gltf: GLTF2

Pygltflib GLTF2 object

byte_length: int

Length of the buffer

uri: str

Path to the external .bin file.