kcc5
Class KCC_RingsTrap

Object
  common:Generic
      common:TrapShape
          kcc5:KCC_RingsTrap

class 
TrapShape:KCC_RingsTrap

The Rings trap.

For an example of what this trap looks like, click here.

Ultra Fractal Source

Toggle UF Source Code Display

 class KCC_RingsTrap( common.ulb:TrapShape ) {
 ; The Rings trap.
 ; <p>
 ; For an example of what this trap looks like,
 ; <a href="../additional/kcc5/images/Rings Trap.jpg">click here</a>.
 ;
 public:
   import "common.ulb"
 
   ; constructor
   func KCC_RingsTrap( Generic pparent )
     TrapShape.TrapShape( pparent )
   endfunc
 
   ; call this before each sequence of values to be trapped
   func Init( complex pz )
     TrapShape.Init( pz )
   endfunc
 
   ; call this for each iteration being trapped
   float func Iterate( complex pz )
     TrapShape.Iterate( pz )
 
     size = abs( |pz| - 0.25 )
     if( size < @ringSize )
       m_LastChannel = m_Iterations
       m_Texture = size / @ringSize
       return size
     else
       return 1e20
     endif
   endfunc
 
   float func GetTextureValue()
     return m_Texture
   endfunc
 
 protected:
   float size
   float m_Texture
 
 default:
   title = "Rings Trap"
 
   int param v_KCC_RingsTrap
     caption = "Version (KCC_RingsTrap)"
     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_KCC_RingsTrap < 100
   endparam
 
   float param ringSize
     caption = "Ring Size"
     default = 0.1
     hint = "The size of the ring.  Suggested range (0.005 to 0.3)."
   endparam
 }
 

Constructor Summary

KCC_RingsTrap()

KCC_RingsTrap(Generic pparent)
constructor

Method Summary

float	GetTextureValue() Get texture value.
void	Init(complex pz) call this before each sequence of values to be trapped
float	Iterate(complex pz) call this for each iteration being trapped

Methods inherited from class common:TrapShape

GetColorChannel, GetTransformedPoint, IterateSilent, SetThreshold

Methods inherited from class common:Generic

GetParent

Methods inherited from class Object

Constructor Detail

KCC_RingsTrap

public KCC_RingsTrap(Generic pparent)

constructor

KCC_RingsTrap

public KCC_RingsTrap()

Method Detail

Init

public void Init(complex pz)

call this before each sequence of values to be trapped

Overrides:

Init in class TrapShape

Iterate

public float Iterate(complex pz)

call this for each iteration being trapped

Overrides:

Iterate in class TrapShape

GetTextureValue

public float GetTextureValue()

Description copied from class: TrapShape

Get texture value.

Ordinarily, a trap shape does not have a native texture (it is flat). Some formulas may pair trap shapes with trap textures, and may need more information about trap textures when trap shapes are nested via TrapShapeMerge. This function provides support for accessing texture information.

Overrides:

GetTextureValue in class TrapShape

Returns:

the texture value for the last point used (i.e. call GetTextureValue() after calling Iterate(), not before)