Package mgui.util

Class Colour

java.lang.Object
mgui.util.Colour
All Implemented Interfaces:
XMLObject
Direct Known Subclasses:
Colour1f, Colour2f, Colour3f, Colour4f
public abstract class Colour
extends java.lang.Object
implements XMLObject

  • Nested Class Summary

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

    XMLObject.XMLEncoding, XMLObject.XMLType

  • Constructor Summary

    Constructors
    Constructor Description
    Colour()  

  • Method Summary

    Modifier and Type Method Description
    float getAlpha()  
    float getBlue()  
    java.awt.Color getColor()  
    org.jogamp.vecmath.Color3f getColor3f()  
    org.jogamp.vecmath.Color4f getColor4f()  
    Colour getColour​(java.lang.Object o)  
    float getDim​(int i)  
    int getDims()  
    java.lang.String getDTD()
    Returns the Data Type Declaration (DTD) for this object's XML representation
    float getGreen()  
    float getIntensity()  
    java.lang.String getLocalName()
    Returns the local name associated with this XML object.
    float getRed()  
    java.lang.String getShortXML​(int tab)
    Returns a short XML representation of this object.
    java.lang.String getXML()
    Returns this object's XML representation as a single string.
    java.lang.String getXML​(int tab)
    Returns this object's XML representation as a single string.
    java.lang.String getXMLSchema()
    Returns the XML schema for this object's XML representation
    void handleXMLElementEnd​(java.lang.String localName)
    Handles the end of an XML element.
    void handleXMLElementStart​(java.lang.String localName, org.xml.sax.Attributes attributes, XMLObject.XMLType type)
    Handles the start of an XML element.
    void handleXMLString​(java.lang.String s)
    Handles a string within an XML element.
    void set​(java.awt.Color c)  
    void setAlpha​(float a)  
    void setAlpha​(int a)  
    void setBlue​(float b)  
    void setBlue​(int b)  
    void setDim​(int i, float val)  
    void setGreen​(float g)  
    void setGreen​(int g)  
    void setIntensity​(float i)  
    void setIntensity​(int i)  
    void setRed​(float r)  
    void setRed​(int r)  
    void writeXML​(int tab, java.io.Writer writer)
    Writes the XML representation of this object to file.
    void writeXML​(int tab, java.io.Writer writer, ProgressUpdater progress_bar)
    Writes the XML representation of this object to file, as XMLType.Normal.
    void writeXML​(int tab, java.io.Writer writer, XMLOutputOptions options, ProgressUpdater progress_bar)
    Writes the XML representation of this object to file.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Colour

      public Colour()

  • Method Details

    • getRed

      public float getRed()

    • getBlue

      public float getBlue()

    • getGreen

      public float getGreen()

    • getAlpha

      public float getAlpha()

    • getIntensity

      public float getIntensity()

    • setRed

      public void setRed​(int r)

    • setBlue

      public void setBlue​(int b)

    • setGreen

      public void setGreen​(int g)

    • setAlpha

      public void setAlpha​(int a)

    • setIntensity

      public void setIntensity​(int i)

    • setRed

      public void setRed​(float r)

    • setBlue

      public void setBlue​(float b)

    • setGreen

      public void setGreen​(float g)

    • setAlpha

      public void setAlpha​(float a)

    • setIntensity

      public void setIntensity​(float i)

    • getDims

      public int getDims()

    • getDim

      public float getDim​(int i)

    • setDim

      public void setDim​(int i, float val)

    • getColor4f

      public org.jogamp.vecmath.Color4f getColor4f()

    • getColor3f

      public org.jogamp.vecmath.Color3f getColor3f()

    • getColour

      public Colour getColour​(java.lang.Object o)

    • set

      public void set​(java.awt.Color c)

    • getColor

      public java.awt.Color getColor()

    • getDTD

      public java.lang.String getDTD()
      Description copied from interface: XMLObject
      Returns the Data Type Declaration (DTD) for this object's XML representation

      See http://en.wikipedia.org/wiki/Document_Type_Definition for a description.

      Specified by:
      getDTD in interface XMLObject
      Returns:

    • getXML

      public java.lang.String getXML()
      Description copied from interface: XMLObject
      Returns this object's XML representation as a single string. NOTE: this is not feasible for larger objects and containers, thus may not be implemented for these objects. Use the XMLObject.writeXML(int,java.io.Writer,mgui.io.standard.xml.XMLOutputOptions,mgui.interfaces.ProgressUpdater) functions to write larger objects to file.
      Specified by:
      getXML in interface XMLObject
      Returns:

    • getXML

      public java.lang.String getXML​(int tab)
      Description copied from interface: XMLObject
      Returns this object's XML representation as a single string. NOTE: this is not feasible for larger objects and containers, thus may not be implemented for these objects. Use the XMLObject.writeXML(int,java.io.Writer,mgui.io.standard.xml.XMLOutputOptions,mgui.interfaces.ProgressUpdater) functions to write larger objects to file.
      Specified by:
      getXML in interface XMLObject
      Parameters:
      tab - The number of tabs to place before the opening XML wrapper
      Returns:

    • getXMLSchema

      public java.lang.String getXMLSchema()
      Description copied from interface: XMLObject
      Returns the XML schema for this object's XML representation

      See http://en.wikipedia.org/wiki/XML_schema.

      Specified by:
      getXMLSchema in interface XMLObject
      Returns:

    • handleXMLElementStart

      public void handleXMLElementStart​(java.lang.String localName, org.xml.sax.Attributes attributes, XMLObject.XMLType type)
      Description copied from interface: XMLObject
      Handles the start of an XML element.
      Specified by:
      handleXMLElementStart in interface XMLObject
      Parameters:
      localName - Local name of the element
      attributes - Set of element attributes
      type - The XMLType of this element

    • handleXMLElementEnd

      public void handleXMLElementEnd​(java.lang.String localName)
      Description copied from interface: XMLObject
      Handles the end of an XML element.
      Specified by:
      handleXMLElementEnd in interface XMLObject
      Parameters:
      localName - Local name of the element

    • handleXMLString

      public void handleXMLString​(java.lang.String s)
      Description copied from interface: XMLObject
      Handles a string within an XML element.
      Specified by:
      handleXMLString in interface XMLObject
      Parameters:
      s - String to handle

    • getLocalName

      public java.lang.String getLocalName()
      Description copied from interface: XMLObject
      Returns the local name associated with this XML object.
      Specified by:
      getLocalName in interface XMLObject
      Returns:

    • writeXML

      public void writeXML​(int tab, java.io.Writer writer) throws java.io.IOException
      Description copied from interface: XMLObject
      Writes the XML representation of this object to file. The basic contract for this method is that it should not write a newline character at its start or end. The default format of XMLFormat.Ascii will be used.
      Specified by:
      writeXML in interface XMLObject
      Parameters:
      tab - The number of tabs to place before the XML text
      writer - The writer
      Throws:
      java.io.IOException

    • writeXML

      public void writeXML​(int tab, java.io.Writer writer, ProgressUpdater progress_bar) throws java.io.IOException
      Description copied from interface: XMLObject
      Writes the XML representation of this object to file, as XMLType.Normal. The default format of XMLFormat.Ascii will be used. The basic contract for this method is that it should not write a newline character at its start or end.
      Specified by:
      writeXML in interface XMLObject
      Parameters:
      tab - The number of tabs to place before the XML text
      writer - The writer
      progress_bar - Optional progress updater (may be null)
      Throws:
      java.io.IOException

    • writeXML

      public void writeXML​(int tab, java.io.Writer writer, XMLOutputOptions options, ProgressUpdater progress_bar) throws java.io.IOException
      Description copied from interface: XMLObject
      Writes the XML representation of this object to file. The basic contract for this method is that it should not write a newline character at its start or end. The default format of XMLFormat.Ascii will be used.
      Specified by:
      writeXML in interface XMLObject
      Parameters:
      tab - The number of tabs to place before the XML text
      writer - The writer
      options - XMLOutputOptions defining the write parameters
      progress_bar - Optional progress updater (may be null)
      Throws:
      java.io.IOException

    • getShortXML

      public java.lang.String getShortXML​(int tab)
      Description copied from interface: XMLObject
      Returns a short XML representation of this object.
      Specified by:
      getShortXML in interface XMLObject
      Returns: