<viz>.addAvatar

Adds an avatar.

 

<viz>.addAvatar(
    fileName    
    parent = viz.WORLD    
    scene = viz.MainScene    
    flags = 0    

)

 

fileName

Name of avatar file, typically ends with '.cfg'


parent = viz.WORLD

viz.WORLD
viz.SCREEN
viz.HEAD
viz.ORTHO
<node3d> object


scene = viz.MainScene

If the parent is viz.WORLD, viz.SCREEN, or viz.HEAD, then the argument represents the scene to add the object to.
If the parent is viz.ORTHO, then the argument represents the window to add the object to.
If the parent is a valid node3d object, then the argument is ignored.


flags = 0

A combination of the following flags:

Flag

Description

viz.AVATAR_DELAY_LOAD

Delay the loading of all animations specified in the avatar cfg file until they are used for the first time. Useful for speeding up load time and reducing memory usage by not loading unnecessary animations. Using this flag will override any use of the delay_load option in the cfg file.


Remarks

An avatar object can represent any character with a skeleton structure. The avatar can contain any number of animations and morph targets that can be dynamically blended together at runtime.

Return Value

<node3d:avatar> object

Example

avatar = viz.addAvatar('vcc_female.cfg')

See also

<node3d:avatar>.forceAnimationLoad