vrm

Documentation

Index

• Constants
• Variables
• func Unmarshal(data []byte) (interface{}, error)
• func Write(doc *Document, w io.Writer, path string) error
• type BlendShapeBind
• type BlendShapeGroup
• type BlendShapeMaster
• type BlendShapeMaterialValue
• type Bone
• type Document
  • func Parse(r io.Reader, path string) (*Document, error)
  • func (doc *Document) IsExtentionUsed(extname string) bool
  • func (doc *Document) VRM() *VRM
  • func (doc *Document) ValidateBones() error
• type FirstPerson
• type Humanoid
• type MaterialProperty
  • func NewMaterialProperty(name string) *MaterialProperty
• type Metadata
• type Quaternion
• type SecondaryAnimation
• type SecondaryAnimationBoneGroup
• type SecondaryAnimationCollider
• type SecondaryAnimationColliderGroup
• type VRM
  • func NewVRM() *VRM
  • func (v *VRM) Author() string
  • func (v *VRM) CheckRequiredBones() []string
  • func (v *VRM) Title() string

Constants

const ExtensionName = "VRM"

Variables

var ExporterVersion = "modelconv-v0.2"

ExporterVersion

var RequiredBones = []string{
	"hips", "spine", "chest", "neck", "head",
	"leftUpperArm", "leftLowerArm", "leftHand",
	"rightUpperArm", "rightLowerArm", "rightHand",
	"leftUpperLeg", "leftLowerLeg", "leftFoot",
	"rightUpperLeg", "rightLowerLeg", "rightFoot",
}

RequiredBones for Humanoid

Functions

func Unmarshal

func Unmarshal(data []byte) (interface{}, error)

func Write

func Write(doc *Document, w io.Writer, path string) error

Write vrm file

Types

type BlendShapeBind

type BlendShapeBind struct {
	Mesh   uint32  `json:"mesh"`
	Index  int     `json:"index"`
	Weight float64 `json:"weight"`
}

type BlendShapeGroup

type BlendShapeGroup struct {
	Name           string                     `json:"name"`
	PresetName     string                     `json:"presetName"`
	Binds          []*BlendShapeBind          `json:"binds"`
	MaterialValues []*BlendShapeMaterialValue `json:"materialValues,omitempty"`
}

type BlendShapeMaster

type BlendShapeMaster struct {
	BlendShapeGroups []*BlendShapeGroup `json:"blendShapeGroups"`
}

type BlendShapeMaterialValue

type BlendShapeMaterialValue struct {
	MaterialName string    `json:"materialName"`
	PropertyName string    `json:"propertyName"`
	TargetValue  []float64 `json:"targetValue"`
}

type Bone

type Bone struct {
	Bone             string `json:"bone"`
	Node             int    `json:"node"`
	UseDefaultValues bool   `json:"useDefaultValues"`

	Min        *[3]float32 `json:"min,omitempty"`
	Max        *[3]float32 `json:"max,omitempty"`
	Center     *[3]float32 `json:"center,omitempty"`
	AxisLength float32     `json:"axisLength,omitempty"`
}

type Document

type Document gltf.Document

func Parse

func Parse(r io.Reader, path string) (*Document, error)

Parse vrm data

func (*Document) IsExtentionUsed

func (doc *Document) IsExtentionUsed(extname string) bool

func (*Document) VRM

func (doc *Document) VRM() *VRM

func (*Document) ValidateBones

func (doc *Document) ValidateBones() error

type FirstPerson

type FirstPerson struct {
	FirstPersonBone       int                `json:"firstPersonBone,omitempty"`
	FirstPersonBoneOffset map[string]float64 `json:"firstPersonBoneOffset,omitempty"`

	MeshAnnotations []interface{} `json:"meshAnnotations,omitempty"`

	LookAtTypeName        string                 `json:"lookAtTypeName,omitempty"`
	LookAtHorizontalInner map[string]interface{} `json:"lookAtHorizontalInner,omitempty"`
	LookAtHorizontalOuter map[string]interface{} `json:"lookAtHorizontalOuter,omitempty"`
	LookAtVerticalDown    map[string]interface{} `json:"lookAtVerticalDown,omitempty"`
	LookAtVerticalUp      map[string]interface{} `json:"lookAtVerticalUp,omitempty"`
}

type Humanoid

type Humanoid struct {
	Bones []*Bone `json:"humanBones"`
}

type MaterialProperty

type MaterialProperty struct {
	Name              string               `json:"name"`
	Shader            string               `json:"shader"`
	RenderQueue       int                  `json:"renderQueue"`
	FloatProperties   map[string]float64   `json:"floatProperties"`
	VectorProperties  map[string][]float64 `json:"vectorProperties"`
	TextureProperties map[string]uint32    `json:"textureProperties"`
	KeywordMap        map[string]bool      `json:"keywordMap"`
	TagMap            map[string]string    `json:"tagMap"`
}

func NewMaterialProperty

func NewMaterialProperty(name string) *MaterialProperty

type Metadata

type Metadata struct {
	Title   string `json:"title"`
	Version string `json:"version"`
	Author  string `json:"author"`
	Contact string `json:"contactInformation"`
	Texture *int   `json:"texture,omitempty"`

	AllowedUserName      string `json:"allowedUserName,omitempty"`
	ViolentUssageName    string `json:"violentUssageName,omitempty"`
	SexualUssageName     string `json:"sexualUssageName,omitempty"`
	CommercialUssageName string `json:"commercialUssageName,omitempty"`

	OtherPermissionURL string `json:"otherPermissionUrl,omitempty"`

	LicenseName     string `json:"licenseName"`
	OtherLicenseURL string `json:"otherLicenseUrl"`
}

type Quaternion

type Quaternion = geom.Vector4

type SecondaryAnimation

type SecondaryAnimation struct {
	BoneGroups     []*SecondaryAnimationBoneGroup     `json:"boneGroups,omitempty"`
	ColliderGroups []*SecondaryAnimationColliderGroup `json:"colliderGroups,omitempty"`
}

type SecondaryAnimationBoneGroup

type SecondaryAnimationBoneGroup struct {
	Comment        string             `json:"comment"`
	Stiffiness     float64            `json:"stiffiness"`
	GravityPower   float64            `json:"gravityPower"`
	GravityDir     map[string]float64 `json:"gravityDir,omitempty"`
	DragForce      float64            `json:"dragForce"`
	HitRadius      float64            `json:"hitRadius"`
	Center         int                `json:"center"`
	Bones          []int              `json:"bones"`
	ColliderGroups []int              `json:"colliderGroups,omitempty"`
}

type SecondaryAnimationCollider

type SecondaryAnimationCollider struct {
	Radius float64            `json:"radius"`
	Offset map[string]float64 `json:"offset"`
}

type SecondaryAnimationColliderGroup

type SecondaryAnimationColliderGroup struct {
	Node      uint32                        `json:"node"`
	Colliders []*SecondaryAnimationCollider `json:"colliders"`
}

type VRM

type VRM struct {
	Meta     Metadata `json:"meta"`
	Humanoid Humanoid `json:"humanoid"`

	FirstPerson        *FirstPerson        `json:"firstPerson,omitempty"`
	BlendShapeMaster   BlendShapeMaster    `json:"blendShapeMaster,omitempty"`
	SecondaryAnimation *SecondaryAnimation `json:"secondaryAnimation,omitempty"`
	MaterialProperties []*MaterialProperty `json:"materialProperties"`

	ExporterVersion string `json:"exporterVersion"`
}

func NewVRM

func NewVRM() *VRM

func (*VRM) Author

func (v *VRM) Author() string

func (*VRM) CheckRequiredBones

func (v *VRM) CheckRequiredBones() []string

func (*VRM) Title

func (v *VRM) Title() string