common
Class ColorTransfer

Object
  extended by common:Generic
      extended by common:ColorTransfer
Direct Known Subclasses:
DMJ_Colorize, NullColorTransfer

class 
Generic:ColorTransfer

This is a generic color transfer class. It accepts one or more color values in sequence and returns a color value for each. Compare this to the Transform and Transfer base classes.


Ultra Fractal Source

Toggle UF Source Code Display

 class ColorTransfer(Generic) {
   ; This is a generic color transfer class. It accepts one or more
   ; color values in sequence and returns a color value for each.
   ; Compare this to the Transform and Transfer base classes.
   
 public:
   ; constructor
   func ColorTransfer(Generic pparent)
     Generic.Generic(pparent)
   endfunc
   
   ; call this to begin processing a sequence
   ; NOTE: although ColorTransfer computes colors, it is still initialized
   ; with a complex value, usually corresponding to the point this
   ; is being applied to
   func Init(complex pz)
     m_Iterations = 0
   endfunc
   
   ; call this to process another value in the sequence
   color func Iterate(color pcolor)
     m_Iterations = m_Iterations + 1
     return pcolor
   endfunc
   
   ; Update internal counters without transforming a value
   ;
   func IterateSilent()
     ; Perform the same iteration-count update as Iterate(), but
     ; don't return a value. See the comments in Iterate() for
     ; more information on when to call this.
     m_Iterations = m_Iterations + 1
   endfunc
 
 protected:
   int m_Iterations    ; count the number of iterations
 
 default:
   int param v_colortransfer
     caption = "Version (ColorTransfer)"
     default = 100
     hint = "This version parameter is used to detect when a change has been made to the formula that is incompatible with the previous version. When that happens, this field will reflect the old version number to alert you to the fact that an alternate rendering is being used."
     visible = @v_colortransfer < 100
   endparam
 }
 


Constructor Summary
ColorTransfer()
           
ColorTransfer(Generic pparent)
          constructor
 
Method Summary
 void Init(complex pz)
          call this to begin processing a sequence NOTE: although ColorTransfer computes colors, it is still initialized with a complex value, usually corresponding to the point this is being applied to
 color Iterate(color pcolor)
          call this to process another value in the sequence
 void IterateSilent()
          Update internal counters without transforming a value
 
Methods inherited from class common:Generic
GetParent
 
Methods inherited from class Object
 

Constructor Detail

ColorTransfer

public ColorTransfer(Generic pparent)
constructor


ColorTransfer

public ColorTransfer()
Method Detail

Init

public void Init(complex pz)
call this to begin processing a sequence NOTE: although ColorTransfer computes colors, it is still initialized with a complex value, usually corresponding to the point this is being applied to


Iterate

public color Iterate(color pcolor)
call this to process another value in the sequence


IterateSilent

public void IterateSilent()
Update internal counters without transforming a value