GlowBit.py
Public Member Functions | List of all members
glowbit.colourMaps Class Reference

Methods which calculate colour gradients. More...

Inheritance diagram for glowbit.colourMaps:
Inheritance graph
[legend]

Public Member Functions

def colourMapSolid (self, index, minIndex, maxIndex)
 Trivial colourmap method which always returns the colour in the parent object. More...
 
def colourMapRainbow (self, index, minIndex, maxIndex)
 Maps the pure hue colour wheel between minIndex and maxIndex. More...
 

Detailed Description

Methods which calculate colour gradients.

Custom colour map methods can be written and passed to several GlowBit library methods (eg: glowbit.stick.graph1D) but must accept the same positional arguments as the methods in this class:

def colourMapFunction(self, index, minIndex, maxIndex):

Member Function Documentation

◆ colourMapRainbow()

def glowbit.colourMaps.colourMapRainbow (   self,
  index,
  minIndex,
  maxIndex 
)

Maps the pure hue colour wheel between minIndex and maxIndex.

Parameters
indexThe value to be mapped
minIndexThe value of index mapped to a colour wheel angle of 0 degrees
maxIndexThe value of index mapped to a colour wheel angle of 360 degrees
Returns
The 32-bit packed GlowBit colour value

◆ colourMapSolid()

def glowbit.colourMaps.colourMapSolid (   self,
  index,
  minIndex,
  maxIndex 
)

Trivial colourmap method which always returns the colour in the parent object.

Parameters
indexDummy argument for compatibility with colourmap method API
minIndexDummy argument for compatibility with colourmap method API
maxIndexDummy argument for compatibility with colourmap method API

The documentation for this class was generated from the following file: