API Reference

Class List

pc.Model

A model is a graphical object that can be added to or removed from a scene. It contains a hierarchy and any number of mesh instances.

// Create a new model
var model = new pc.Model();

Summary

Properties

graphThe root node of the model's graph node hierarchy.
meshInstancesAn array of meshInstances contained in this model.

Methods

cloneClones a model.
destroydestroys skinning texture and possibly deletes vertex/index buffers of a model.
generateWireframeGenerates the necessary internal data for a model to be renderable as wireframe.

Details

Constructor

Model()

Creates a new model.

// Create a new model
var model = new pc.Model();

Properties

pc.GraphNodegraph

The root node of the model's graph node hierarchy.

pc.MeshInstance[]meshInstances

An array of meshInstances contained in this model.

Methods

clone()

Clones a model. The returned model has a newly created hierarchy and mesh instances, but meshes are shared between the clone and the specified model.

var clonedModel = model.clone();

Returns

pc.Model A clone of the specified model.

destroy()

destroys skinning texture and possibly deletes vertex/index buffers of a model. Mesh is reference-counted, so buffers are only deleted if all models with referencing mesh instances were deleted. That means all in-scene models + the "base" one (asset.resource) which is created when the model is parsed. It is recommended to use asset.unload() instead, which will also remove the model from the scene.

generateWireframe()

Generates the necessary internal data for a model to be renderable as wireframe. Once this function has been called, any mesh instance in the model can have its renderStyle property set to pc.RENDERSTYLE_WIREFRAME

model.generateWireframe();
for (var i = 0; i < model.meshInstances.length; i++) {
    model.meshInstances[i].renderStyle = pc.RENDERSTYLE_WIREFRAME;
}