xeometry

1.0.0
Need help reading this?

CameraControl

Controls the camera of a xeometry.Viewer with the mouse.

This is xeometry's bundled, default camera control.

new CameraControl(viewer: Viewer, cfg: Object?)
Parameters
viewer (Viewer) A Viewer.
cfg (Object?) Configs
Example
var viewer = new xeometry.Viewer();
var cameraControl = new xeometry.CameraControl(viewer);

Viewer

A JavaScript API for viewing glTF models on WebGL.

A xeometry Viewer is a single class that wraps xeogl in a set of simple data-driven methods focused on loading glTF models and manipulating their objects to create cool presentations.

new Viewer(cfg: Object?)
Parameters
cfg (Object?) Configs
Name Description
cfg.loadModel Function? Callback fired to load model
cfg.loadedModel Function? Callback fired when model loaded
cfg.unloadedModel Function? Callback fired when model unloaded
cfg.contextAttr Object? WebGL context attributes
Example
// Create viewer with default canvas
var viewer1 = new xeometry.Viewer();

// Create viewer bound to an existing canvas
var viewer2 = new xeometry.Viewer({
    canvas: "theCanvas"
});

// Create viewer that loads via custom loader callback
var viewer3 = new xeometry.Viewer({
    loadModel: function (modelId, src, ok, error) {
        var request = new XMLHttpRequest();
        request.overrideMimeType("application/json");
        request.open('GET', src2, true);
        request.onreadystatechange = function () {
            if (request.readyState == 4 && // Request finished, response ready
                request.status == "200") { // Status OK
                    var json = JSON.parse(request.responseText);
                    ok(json, this);
            }
        };
        request.send(null);
    },
    loadedModel: function(modelId, src, ok) {
        console.log("Loaded modelId=" + modelId);
        ok(); // Unblock the viewer
    },
    unloadedModel: function(modelId, src) {
        console.log("Unloaded modelId=" + modelId);
    }
});
Instance Members
▸ scheduleTask(callback, scope?)
▸ getCanvas()
▸ getOverlay()
▸ loadModel(id, src, ok?)
▸ models
▸ getSrc(id)
▸ getModel(id)
▸ getObjects(id?)
▸ clear()
▸ setType(id, type)
▸ getType(id)
▸ getTypes()
▸ getPrimitive(id)
▸ getPositions(id)
▸ getIndices(id)
▸ setScale(id, xyz)
▸ getScale(id)
▸ setRotate
▸ getRotate(id)
▸ setTranslate(id, xyz)
▸ addTranslate(id, xyz)
▸ getTranslate(id)
▸ show(ids?)
▸ hide(ids)
▸ setOpacity(ids, opacity)
▸ getOpacity(id)
▸ setColor(ids, color)
▸ getColor(id)
▸ setClippable(ids?)
▸ setUnclippable(ids)
▸ showOutline(ids)
▸ hideOutline(ids)
▸ setOutlineThickness(thickness)
▸ getOutlineThickness()
▸ setOutlineColor(color)
▸ getOutlineColor()
▸ getCenter(target)
▸ getAABB(target)
▸ setPerspectiveFOV(fov)
▸ getPerspectiveFOV()
▸ setPerspectiveNear(near)
▸ getPerspectiveNear()
▸ setPerspectiveFar(far)
▸ getPerspectiveFar()
▸ setOrthoScale(scale)
▸ getOrthoScale()
▸ setOrthoNear(near)
▸ getOrthoNear()
▸ setOrthoFar(far)
▸ getOrthoFar()
▸ setProjection(type)
▸ getProjection()
▸ setEye(eye)
▸ getEye()
▸ setLook(look)
▸ getLook()
▸ setUp(up)
▸ getUp()
▸ setEyeLookUp(eye, look, up)
▸ lockGimbalY()
▸ unlockGimbalY()
▸ rotateEyeY(angle)
▸ rotateEyeX(angle)
▸ rotateLookY(angle)
▸ rotateLookX(angle)
▸ pan(pan)
▸ zoom(delta)
▸ setViewFitDuration(value)
▸ getViewFitDuration()
▸ setViewFitFOV(value)
▸ getViewFitFOV()
▸ viewFit(target, ok?)
▸ viewFitRight(target, ok?)
▸ viewFitBack(target, ok?)
▸ viewFitLeft(target, ok?)
▸ viewFitFront(target, ok?)
▸ viewFitTop(target, ok?)
▸ viewFitBottom(target, ok?)
▸ yspin(value)
▸ xspin(value)
▸ rayCastObject(origin, dir)
▸ rayCastSurface(origin, dir)
▸ pickObject(canvasPos)
▸ pickSurface(canvasPos)
▸ createAnnotation(id, cfg)
▸ getAnnotations(id)
▸ destroyAnnotations()
▸ setAnnotationPrimIndex(id, primIndex)
▸ getAnnotationPrimIndex(id)
▸ setAnnotationGlyph(id, glyph)
▸ getAnnotationGlyph(id)
▸ setAnnotationTitle(id, title)
▸ getAnnotationTitle(id)
▸ setAnnotationDesc(id, desc, title)
▸ getAnnotationDesc(id)
▸ setAnnotationBary(id, bary)
▸ getAnnotationBary(id)
▸ setAnnotationObject(id, objectId)
▸ getAnnotationObject(id)
▸ setAnnotationEye(id, eye)
▸ getAnnotationEye(id, eye)
▸ setAnnotationLook(id, look)
▸ getAnnotationLook(id)
▸ setAnnotationUp(id, up)
▸ getAnnotationUp(id)
▸ setAnnotationOccludable(id, occludable)
▸ getAnnotationOccludable(id)
▸ setAnnotationPinShown(id, pinShown)
▸ getAnnotationPinShown(id)
▸ setAnnotationLabelShown(id, labelShown)
▸ getAnnotationLabelShown(id)
▸ createClip(id, cfg)
▸ getClips()
▸ destroyClips()
▸ enable(id)
▸ disable(id)
▸ createLight(id, cfg)
▸ getLights()
▸ destroyLights()
▸ defaultLights()
▸ getLightType
▸ setPos(id, pos = 0,0,0)
▸ getPos(id)
▸ setDir(id, dir = 0,0,1)
▸ getDir(id)
▸ setIntensity(id, intensity)
▸ getIntensity(id)
▸ setSpace(id, space)
▸ getSpace(id)
▸ destroy(id)
▸ getBookmark
▸ setBookmark
▸ getSnapshot(params?, ok)
▸ on(event, callback)
▸ fire(event, value)

error

Clears and destroys this viewer.

error(msg: any): Viewer
Parameters
msg (any)
Returns
Viewer: this