modeler

package

v0.17.1 Latest Latest Go to latest Published: Oct 31, 2020 License: BSD-2-Clause Imports: 10 Imported by: 25

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/qmuntal/gltf

Links

Open Source Insights

Documentation ¶

Overview ¶

Package modeler implements helper methods to write common glTF entities (indices, positions, colors, ...) into buffers.

Example ¶

package main

import (
	"github.com/qmuntal/gltf"
	"github.com/qmuntal/gltf/modeler"
)

func main() {
	doc := gltf.NewDocument()
	positionAccessor := modeler.WritePosition(doc, [][3]float32{{43, 43, 0}, {83, 43, 0}, {63, 63, 40}, {43, 83, 0}, {83, 83, 0}})
	indicesAccessor := modeler.WriteIndices(doc, []uint8{0, 1, 2, 3, 1, 0, 0, 2, 3, 1, 4, 2, 4, 3, 2, 4, 1, 3})
	colorIndices := modeler.WriteColor(doc, [][3]uint8{{50, 155, 255}, {0, 100, 200}, {255, 155, 50}, {155, 155, 155}, {25, 25, 25}})
	doc.Meshes = []*gltf.Mesh{{
		Name: "Pyramid",
		Primitives: []*gltf.Primitive{
			{
				Indices: gltf.Index(indicesAccessor),
				Attributes: map[string]uint32{
					"POSITION": positionAccessor,
					"COLOR_0":  colorIndices,
				},
			},
		},
	}}
	doc.Nodes = []*gltf.Node{{Name: "Root", Mesh: gltf.Index(0)}}
	doc.Scenes[0].Nodes = append(doc.Scenes[0].Nodes, 0)
	if err := gltf.SaveBinary(doc, "./example.glb"); err != nil {
		panic(err)
	}
}

Output:

Index ¶

func ReadAccessor(doc *gltf.Document, acr *gltf.Accessor, data interface{}) (interface{}, error)
func ReadBufferView(doc *gltf.Document, bv *gltf.BufferView) ([]byte, error)
func ReadColor(doc *gltf.Document, acr *gltf.Accessor, buffer [][4]uint8) ([][4]uint8, error)
func ReadColor64(doc *gltf.Document, acr *gltf.Accessor, buffer [][4]uint16) ([][4]uint16, error)
func ReadIndices(doc *gltf.Document, acr *gltf.Accessor, buffer []uint32) ([]uint32, error)
func ReadJoints(doc *gltf.Document, acr *gltf.Accessor, buffer [][4]uint16) ([][4]uint16, error)
func ReadNormal(doc *gltf.Document, acr *gltf.Accessor, buffer [][3]float32) ([][3]float32, error)
func ReadPosition(doc *gltf.Document, acr *gltf.Accessor, buffer [][3]float32) ([][3]float32, error)
func ReadTangent(doc *gltf.Document, acr *gltf.Accessor, buffer [][4]float32) ([][4]float32, error)
func ReadTextureCoord(doc *gltf.Document, acr *gltf.Accessor, buffer [][2]float32) ([][2]float32, error)
func ReadWeights(doc *gltf.Document, acr *gltf.Accessor, buffer [][4]float32) ([][4]float32, error)
func WriteAccessor(doc *gltf.Document, target gltf.Target, data interface{}) uint32
func WriteBufferView(doc *gltf.Document, target gltf.Target, data interface{}) uint32
func WriteColor(doc *gltf.Document, data interface{}) uint32
func WriteImage(doc *gltf.Document, name string, mimeType string, r io.Reader) (uint32, error)
func WriteIndices(doc *gltf.Document, data interface{}) uint32
func WriteJoints(doc *gltf.Document, data interface{}) uint32
func WriteNormal(doc *gltf.Document, data [][3]float32) uint32
func WritePosition(doc *gltf.Document, data [][3]float32) uint32
func WriteTangent(doc *gltf.Document, data [][4]float32) uint32
func WriteTextureCoord(doc *gltf.Document, data interface{}) uint32
func WriteWeights(doc *gltf.Document, data interface{}) uint32

Examples ¶

Package

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ReadAccessor ¶ added in v0.17.0

func ReadAccessor(doc *gltf.Document, acr *gltf.Accessor, data interface{}) (interface{}, error)

ReadAccessor returns the data references by acr as an slice whose element types are the ones associated with acr.ComponentType and acr.Type.

If data is an slice whose elements type matches the accessor type then data will be used as backing slice, else a new slice will be allocated.

ReadAccessor supports all types of accessors: non-interleaved, interleaved, sparse, without buffer views, ..., and any combinations of them.

ReadAccessor is safe to use even with malformed documents. If that happens it will return an error instead of panic.

func ReadBufferView ¶ added in v0.17.0

func ReadBufferView(doc *gltf.Document, bv *gltf.BufferView) ([]byte, error)

ReadBufferView returns the slice of bytes associated with the BufferView.

It is safe to use even with malformed documents. If that happens it will return an error instead of panic.

func ReadColor ¶ added in v0.17.0

func ReadColor(doc *gltf.Document, acr *gltf.Accessor, buffer [][4]uint8) ([][4]uint8, error)

ReadColor returns the data referenced by acr. If acr.ComponentType is other than Ubyte the data will be converted and normalized appropriately.