common
Class Transfer

Object
  common:Generic
      common:Transfer

Direct Known Subclasses:

DefaultGradientTransfer, DMJ_TrapDiameter, JLB_TrapTransferCollection, MMF_TransferMerge, MMF_TrapTransfer, NullTransfer, Standard_HeightTransfer, TransferDistanceVariants, TrapTransfer, TrapTransferBias

class 
Generic:Transfer

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

Ultra Fractal Source

Toggle UF Source Code Display

 class Transfer(Generic) {
   ; This is a generic transfer class. It accepts one or more
   ; real values in sequence and returns a real value for each.
   ; Compare this to the Transform base class.
   
 public:
   ; constructor
   func Transfer(Generic pparent)
     Generic.Generic(pparent)
   endfunc
   
   ; call this to begin processing a sequence
   ; NOTE: although Transfer computes reals, 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
   float func Iterate(float pr)
     m_Iterations = m_Iterations + 1
     return pr
   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_transfer
     caption = "Version (Transfer)"
     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_transfer < 100
   endparam
 }
 

Constructor Summary

Transfer()

Transfer(Generic pparent)
constructor

Method Summary

void	Init(complex pz) call this to begin processing a sequence NOTE: although Transfer computes reals, it is still initialized with a complex value, usually corresponding to the point this is being applied to
float	Iterate(float pr) 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

Transfer

public Transfer(Generic pparent)

constructor

Transfer

public Transfer()

Method Detail

Init

public void Init(complex pz)

call this to begin processing a sequence NOTE: although Transfer computes reals, it is still initialized with a complex value, usually corresponding to the point this is being applied to

Iterate

public float Iterate(float pr)

call this to process another value in the sequence

IterateSilent

public void IterateSilent()

Update internal counters without transforming a value