X.fibers
/**
* Create fibers. Fibers are displayable objects and can be loaded from a file.
*
* @constructor
* @extends X.object
* @mixin X.loadable
*/
var f = new X.fibers();
/**
* The caption of this object.
*
* @type {?string}
* @protected
*/
f._caption = $_CAPTION;
/**
* The children of this object.
*
* @type {!Array}
* @protected
*/
f._children = $_CHILDREN;
/**
* The className of this class.
*
* @type {string}
* @protected
*/
f._classname = $_CLASSNAME;
/**
* The object color. By default, this is white.
*
* @type {!Array}
* @public
*/
f._color = $_COLOR;
/**
* The point colors of this object.
*
* @type {?X.triplets}
* @protected
*/
f._colors = $_COLORS;
/**
* The color table of this object.
*
* @type {?X.colortable}
* @protected
*/
f._colortable = $_COLORTABLE;
/**
* The 'dirty' flag of this object.
*
* @type {boolean}
* @protected
*/
f._dirty = $_DIRTY;
/**
* This distance of this object to the viewer's eye.
*
* @type {number}
* @protected
*/
f._distance = $_DISTANCE;
/**
* The file of this loadable object.
*
* @type {?X.file}
* @protected
*/
f._file = $_FILE;
/**
* The file data.
*
* @type {?ArrayBuffer}
* @protected
*/
f._filedata = $_FILEDATA;
/**
* The uniqueId of this instance. Each class instance in XTK has a uniqueId.
*
* @type {number}
* @protected
*/
f._id = $_ID;
/**
* The line width, only used in X.displayable.types.LINES mode.
*
* @type {number}
* @protected
*/
f._linewidth = $_LINEWIDTH;
/**
* The flag for the magic mode.
*
* @type {!boolean}
* @protected
*/
f._magicmode = $_MAGICMODE;
/**
* The normals of this object.
*
* @type {?X.triplets}
* @protected
*/
f._normals = $_NORMALS;
/**
* The opacity of this object.
*
* @type {number}
* @protected
*/
f._opacity = $_OPACITY;
/**
* An array reflecting the point or vertex indices.
*
* @type {!Array}
* @protected
*/
f._pointIndices = $_POINTINDICES;
/**
* The points of this object.
*
* @type {?X.triplets}
* @protected
*/
f._points = $_POINTS;
/**
* The point size, only used in X.displayable.types.POINTS mode.
*
* @type {number}
* @protected
*/
f._pointsize = $_POINTSIZE;
/**
* The scalars of this object.
*
* @type {?X.scalars}
* @protected
*/
f._scalars = $_SCALARS;
/**
* The texture of this object.
*
* @type {?X.texture}
* @protected
*/
f._texture = $_TEXTURE;
/**
* The mapping between object and texture coordinates.
*
* @type {?Array}
* @protected
*/
f._textureCoordinateMap = $_TEXTURECOORDINATEMAP;
/**
* The rendering type of this object, default is
* {X.displayable.types.TRIANGLES}.
*
* @type {X.displayable.types}
* @protected
*/
f._type = $_TYPE;
/**
* The visibility of this object.
*
* @type {boolean}
* @public
*/
f._visible = $_VISIBLE;
/**
* Get the caption of this object.
*
* @return {?string} The caption of this object.
* @public
*/
var _caption = f.caption;
/**
* Set the caption for this object.
*
* @param {?string} caption The caption for this object.
* @public
*/
f.caption = $CAPTION;
/**
* Get the children of this object. Each object can have N children which get
* automatically rendered when the top level object gets rendered.
*
* @return {!Array} The children of this object which are again objects.
*/
var _children = f.children;
/**
* Get the className of this object.
*
* @return {string} The className of this object.
* @public
*/
var _classname = f.classname;
/**
* Get the object color.
*
* @return {!Array} The object color.
*/
var _color = f.color;
/**
* Set the object color. This overrides any point colors.
*
* @param {!Array} color The object color as an array with length 3 and values
* between 0..1.
* @throws {Error} An exception if the given color is invalid.
*/
f.color = $COLOR;
/**
* Get the point colors of this object.
*
* @return {!X.triplets} The point colors.
*/
var _colors = f.colors;
/**
* Set the colors of this object.
*
* @param {!X.triplets} colors The colors.
*/
f.colors = $COLORS;
/**
* The color table associated with this object.
*
* @return {?X.colortable} The color table.
*/
var _colortable = f.colortable;
/**
* Get the associated X.file for this object.
*
* @return {string} The associated file path or null if no file is associated.
*/
var _file = f.file;
/**
* Load this object from a file path or reset the associated file path.
*
* @param {?string|Array} filepath The file path/URL to load. If null, reset the
* associated file. If an array is given, load multiple files (this
* only works for DICOM so far).
*/
f.file = $FILEPATH;
/**
* Get the possibly attached file data for this object.
*
* @return {?string} The associated file data or null if none is attached.
*/
var _filedata = f.filedata;
/**
* Set raw file data for this object. Doing so, skips any additional loading and
* just parses this raw data.
*
* @param {?string|Array} filedata The raw file data to parse.
*/
f.filedata = $FILEDATA;
/**
* Get the id of this instance.
*
* @return {string} The className of this object.
* @public
*/
var _id = f.id;
/**
* Get the line width of this object. The line width is only used in
* X.displayable.types.LINES rendering mode.
*
* @return {!number} The line width.
*/
var _linewidth = f.linewidth;
/**
* Set the line width for this object. The line width is only used in
* X.displayable.types.LINES rendering mode.
*
* @param {!number} width The line width.
* @throws {Error} An exception if the given width is invalid.
*/
f.linewidth = $WIDTH;
/**
* Get the magic mode flag.
*
* @return {!boolean} The magic mode flag.
*/
var _magicmode = f.magicmode;
/**
* Set the magic mode flag.
*
* @param {!boolean} magicmode The magic mode flag.
*/
f.magicmode = $MAGICMODE;
/**
* Get the normals of this object.
*
* @return {!X.triplets} The normals.
*/
var _normals = f.normals;
/**
* Set the normals of this object.
*
* @param {!X.triplets} normals The normals.
*/
f.normals = $NORMALS;
/**
* Get the opacity of this object. If the object is fully opaque, this returns
* 1.
*
* @return {number} The opacity in the range 0..1.
*/
var _opacity = f.opacity;
/**
* Set the opacity of this object.
*
* @param {number} opacity The opacity value in the range 0..1.
*/
f.opacity = $OPACITY;
/**
* Get the points of this object.
*
* @return {!X.triplets} The points.
*/
var _points = f.points;
/**
* Set the points of this object.
*
* @param {!X.triplets} points The points.
*/
f.points = $POINTS;
/**
* Get the point size of this object. The point size is only used in
* X.displayable.types.POINTS rendering mode.
*
* @return {!number} The point size.
*/
var _pointsize = f.pointsize;
/**
* Set the point size for this object. The point size is only used in
* X.displayable.types.POINTS rendering mode.
*
* @param {!number} size The point size.
* @throws {Error} An exception if the given size is invalid.
*/
f.pointsize = $SIZE;
/**
* The scalars associated with this object.
*
* @return {?X.scalars} The scalars.
*/
var _scalars = f.scalars;
/**
* Get the texture of this object.
*
* @return {!X.texture} The texture.
*/
var _texture = f.texture;
/**
* Get the render type of this object.
*
* @return {!string} The render type.
*/
var _type = f.type;
/**
* Set the render type of this object. Valid types are: TRIANGLES,
* TRIANGLE_STRIPS, LINES, POINTS, POLYGONS
*
* @param {!string} type The render type.
*/
f.type = $TYPE;
/**
* Get the visibility of this object.
*
* @return {boolean} TRUE if the object is visible, FALSE otherwise.
* @public
*/
var _visible = f.visible;
/**
* Set the visibility of this object.
*
* @param {boolean} visible The object's new visibility.
* @public
*/
f.visible = $VISIBLE;
/**
* Copies the properties from a given object to this object. The texture,
* textureCoordinateMap and the children are not copied but linked.
*
* @param {*} object The given object.
* @protected
*/
f.copy_($OBJECT);
/**
* Fire a modified event for this object.
*
* @param {?boolean=} propagateEvent An optional flag to stop propagating down to child classes.
*/
f.modified($PROPAGATEEVENT);
/**
* Compare two X.objects by their opacity values and their distance to the
* viewer's eye. Fully opaque objects should be always ordered before
* transparent ones, and the transparent ones should be ordered back-to-front in
* terms of the distance to the viewer's eye.
*
* @param {X.object} object1 Object1 to compare against Object2.
* @param {X.object} object2 Object2 to compare against Object1.
* @return {!number} 1, if Object1 should be ordered after Object2. -1, if
* Object1 should be ordered before Object2
*/
var OPACITY_COMPARATOR = X.fibers.OPACITY_COMPARATOR($OBJECT1, $OBJECT2);
/**
* Different render types for any displayable objects.
*
* @enum {string}
*/
X.fibers.types();