Package mgui.io.domestic.maps

Class Vector3ColourMap

java.lang.Object

mgui.interfaces.AbstractInterfaceObject

mgui.interfaces.maps.ColourMap

mgui.interfaces.maps.ContinuousColourMap

mgui.io.domestic.maps.Vector3ColourMap

All Implemented Interfaces:

java.lang.Cloneable, InterfaceObject, NamedObject, TreeObject, CleanableObject, XMLObject, IconObject

public class Vector3ColourMap
extends ContinuousColourMap

Provides a colour mapping for a vector of size three, such that each element of the vector has a colour assignment, and the resulting colour is a weighting of these colours by x, y, z components:

colour.red = x_red * x_component + y_red * y_component + z_red * z_component
colour.green = x_green * x_component + y_green * y_component + z_green * z_component
colour.blue = x_blue * x_component + y_blue * y_component + z_blue * z_component

Author:

Andrew Reid

Nested Class Summary

Nested classes/interfaces inherited from class mgui.interfaces.maps.ContinuousColourMap

ContinuousColourMap.Anchor

Nested classes/interfaces inherited from interface mgui.interfaces.xml.XMLObject

XMLObject.XMLEncoding, XMLObject.XMLType

Field Summary

Fields

Modifier and Type	Field	Description
Colour3f	x_colour
Colour3f	y_colour
Colour3f	z_colour

Fields inherited from class mgui.interfaces.maps.ContinuousColourMap

anchors, DEFAULT_2, DEFAULT_3, GREY_SCALE, xml_anchors_failed, xml_in_anchors

Fields inherited from class mgui.interfaces.maps.ColourMap

name, nullColour

Fields inherited from class mgui.interfaces.AbstractInterfaceObject

isDestroyed, tree_nodes

Constructor Summary

Constructors

Constructor	Description
Vector3ColourMap()
Vector3ColourMap(java.awt.Color x, java.awt.Color y, java.awt.Color z)
Vector3ColourMap(Colour3f x, Colour3f y, Colour3f z)

Method Summary

Modifier and Type	Method	Description
Colour	getColourForVector(org.jogamp.vecmath.Vector3f v)
void	setColours(Colour3f x, Colour3f y, Colour3f z)

Methods inherited from class mgui.interfaces.maps.ContinuousColourMap

addAnchor, addAnchor, clone, getAnchor, getColor4fArray, getColour, getColour, getColour, getColourAtValue, getColourAtValue, getColourAtValue, getColourAtValue, getDefault2, getDefault3, getDiscreteMap, getGreyScale, getInterpolation, getObjectIcon, getShortXML, getXML, getXMLInstance, handleXMLElementEnd, handleXMLElementStart, normalize, removeAnchor, removeAnchors, resort, setFromMap, toString

Methods inherited from class mgui.interfaces.maps.ColourMap

getColor3fArray, getColor3fArray, getColor4fArray, getColour, getDiscreteMap, getDTD, getLayoutPanel, getLocalName, getName, getXML, getXMLSchema, handleXMLString, printToConsole, setName, writeXML, writeXML, writeXML

Methods inherited from class mgui.interfaces.AbstractInterfaceObject

clean, destroy, getTreeLabel, isDestroyed, issueTreeNode, setTreeNode, updateTreeNodes

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

x_colour

public Colour3f x_colour

y_colour

public Colour3f y_colour

z_colour

public Colour3f z_colour

Constructor Details

Vector3ColourMap

public Vector3ColourMap()

Vector3ColourMap

public Vector3ColourMap(java.awt.Color x,
java.awt.Color y,
java.awt.Color z)

Vector3ColourMap

public Vector3ColourMap(Colour3f x,
Colour3f y,
Colour3f z)

Method Details

setColours

public void setColours(Colour3f x,
Colour3f y,
Colour3f z)

getColourForVector

public Colour getColourForVector(org.jogamp.vecmath.Vector3f v)