vthree

Documentation

Index

• type Basic
  • func (v *Basic) Mount()
  • func (b *Basic) Render() vecty.ComponentOrHTML
  • func (b *Basic) SkipRender(vecty.Component) bool
  • func (v *Basic) Unmount()

Types

type Basic

type Basic struct {
	vecty.Core

	// Wait period is the time renderer sleeps
	// between unrendered frames when Animate returns false.
	// Default WaitPeriod on zero value is 200ms.
	WaitPeriod time.Duration `vecty:"prop"`
	// Markup should be constant during rendering.
	Markup []vecty.MarkupOrChild `vecty:"prop"`
	// Init is called upon mounting. It should not be nil.
	Init func(three.WebGLRenderer) `vecty:"prop"`
	// Animate should return true if user wants to render
	// the current scene. If Animate is nil then scene is rendered
	// as Init left it.
	Animate func(three.WebGLRenderer) bool `vecty:"prop"`
	// Shutdown is called on dismounting the vecty component.
	Shutdown func(three.WebGLRenderer) `vecty:"prop"`
	// contains filtered or unexported fields
}

Basic is a Vecty Component implementation for use with the three package. Basic works by calling Animate callback between rendered frames or if a static scene is to be displayed, by a nil Animate function and a initializer Init function. Init cannot be nil.

All `vecty:"prop"` arguments should remain constant during rendering until Basic is unmounted.

func (*Basic) Mount

func (v *Basic) Mount()

Mount is called automatically by Vecty.

func (*Basic) Render

func (b *Basic) Render() vecty.ComponentOrHTML

Render implements vecty.MarkupOrChild interface.

func (*Basic) SkipRender

func (b *Basic) SkipRender(vecty.Component) bool

func (*Basic) Unmount

func (v *Basic) Unmount()

Unmount will tear down the renderer. It is called automatically by vecty when Basic's node parent is removed from the DOM.