Wikitude ARchitect v2.0 API Documentation

Wikitude ARchitect > AR > Circle
Filters

Class Circle - extends Drawable2D

A Circle drawable represents an ARObject as a plain circle.

The default anchor settings for a Circle are as follows:
  • horizontal anchor: AR.CONST.HORIZONTAL_ANCHOR.CENTER
  • vertical anchor: AR.CONST.VERTICAL_ANCHOR.MIDDLE
On creation, setup parameters can be passed to customize the properties of the Circle.

Example:
//create a new circle and pass some setup parameters to the circle
var circle = new AR.Circle(30, {
  offsetX : 1,
  onClick : function() {
    circle.radius *= 2;
  },
  horizontalAnchor : AR.CONST.HORIZONTAL_ANCHOR.LEFT,
  opacity : 0.9
});

Constructor

Circle ( radius , options )
Parameters:
radius <float> The radius of the circle, in SDUs. Must be a positive number.
options <object> Setup-Parameters to customize additional object properties.

Accepted options-properties are
  • enabled
  • horizontalAnchor
  • verticalAnchor
  • offsetX
  • offsetY
  • zOrder
  • rotation
  • scale
  • opacity
  • onClick
  • style.fillColor
  • style.outlineSize
  • style.outlineColor
  • roll
  • tilt
  • heading
Remark: rotation is a valid property for a Circle, however, it won't have any visual effect.

Properties

radius - float

The radius of the Circle, in SDUs. Must be a positive number.

style - {object}

The Style object describing the style of the Circle. Valid values are:
  • fillColor
  • outlineSize
  • outlineColor

Methods inherited from Drawable2D:

Methods inherited from ARchitectObject:

Methods inherited from Drawable:


Copyright © 2013 Wikitude GmbH. All rights reserved.