c4d.utils.noise.C4DNoise¶

class c4d.utils.noise.C4DNoise¶: An important technique for generating procedural textures is the use of fractal noise.

See also

Noise Types.

Overview¶

Noise Setup
`C4DNoise.CreateMenuContainer()`	Creates a menu container with the different noise options available:
`C4DNoise.EvaluateSampleOffset()`	Evaluates the sample offset.
Parameter Support
`C4DNoise.HasAbsolute()`	Checks if a certain noise type supports the absolute parameter.
`C4DNoise.HasCycles()`	Checks if a certain noise type supports the cycles parameter.
`C4DNoise.HasOctaves()`	Checks if a certain noise type supports the octaves parameter.

Magic Methods
`C4DNoise.__init__()`
Noise Generation
`C4DNoise.Fbm()`	Generate a periodic Fractional Brownian Motion value.
`C4DNoise.Noise()`	Samples a 2D or 3D noise.
`C4DNoise.RidgedMultifractal()`	Generate a periodic fractal function used for such things as landscapes or mountain ranges.
`C4DNoise.SNoise()`	Generate a periodic signed noise value.
`C4DNoise.Turbulence()`	Generate a turbulence value, this is a sum of multiple noises with different frequency.
Noise Setup
`C4DNoise.InitFbm()`	Initializes fractal brownian motion.

Members¶

Noise Setup¶

static C4DNoise.CreateMenuContainer(bIncludeNone=False)¶

Creates a menu container with the different noise options available:

import c4d

bc = c4d.utils.noise.C4DNoise.CreateMenuContainer(False)
for index, name in bc:
    print index, name

Parameters: bIncludeNone (bool) – Include the none option.
Return type: c4d.BaseContainer
Returns: Generated noise menu.

static C4DNoise.EvaluateSampleOffset(type, rOctaves, rDelta)¶

Evaluates the sample offset.

Parameters

type (int) – Noise type.
rOctaves (float) – Number of octaves.
rDelta (float) – Delta.

Return type

float

Returns

The sample offset.

Parameter Support¶

static C4DNoise.HasAbsolute(t)¶

Checks if a certain noise type supports the absolute parameter.

Parameters: t (int) – Noise type.
Return type: bool
Returns: True if absolute is supported, otherwise False.

static C4DNoise.HasCycles(t)¶

Checks if a certain noise type supports the cycles parameter.

Parameters: t (int) – Noise type.
Return type: bool
Returns: True if cycles is supported, otherwise False.

static C4DNoise.HasOctaves(t)¶

Checks if a certain noise type supports the octaves parameter.

Parameters: t (int) – Noise type.
Return type: bool
Returns: True if octaves is supported, otherwise False.

Magic Methods¶

C4DNoise.__init__(self, seed=665)¶

Parameters: seed (int) – Noise seed.

Noise Generation¶

C4DNoise.Fbm(self, p, rOctaves, lRepeat, t=0.0)¶

Generate a periodic Fractional Brownian Motion value.

Note

Needs the call InitFbm() before.

Warning

The rOctaves value must not exceed the value passed to InitFbm() but can be lower.

Parameters

p (c4d.Vector) – The evaluation point.
rOctaves (float) – The octaves
lRepeat (int) – Must be 2^x - 1, where x = [1..10], i.e. one of 1, 3, 7, 15, 31, 63, 127, 255, 511, and 1023. A noise repeats itself in time every 1024 units. Using a smaller repeat the noise will repeat at an earlier time.
t (float) – The time

Return type

float

Returns

The fbm value.

C4DNoise.Noise(self, t, two_d, p, time=0.0, octaves=4.0, absolute=False, sampleRad=0.25, detailAtt=0.25, t_repeat=0)¶

Samples a 2D or 3D noise.

Parameters

t (int) –
The noise Type: Noise Types

Note

Please use InitFbm() before you use one of the following noise types: NOISE_ZADA, NOISE_DISPL_VORONOI, NOISE_OBER, NOISE_FBM, NOISE_BUYA.
two_d (bool) – True for 2D Sampling, False for 3D Sampling
p (c4d.Vector) – Noise coordinate.
time (float) – Time.
octaves (float) – Octaves, if supported. See HasOctaves()
absolute (bool) – Absolute value, if supported. See HasAbsolute()
sampleRad (float) – Sample radius.
detailAtt (float) – Detail attenuation.
t_repeat (int) – Must be 2^x - 1, where x = [1..10], i.e. one of 1, 3, 7, 15, 31, 63, 127, 255, 511, and 1023. A noise repeats itself in time every 1024 units. Using a smaller repeat the noise will repeat at an earlier time.

Return type

float

Returns

Noise sample.

C4DNoise.RidgedMultifractal(self, p, rOctaves, rOffset, rGain, lRepeat, t=0)¶

Generate a periodic fractal function used for such things as landscapes or mountain ranges.

Note

Needs the call InitFbm() before.

Warning

The rOctaves value must not exceed the value passed to InitFbm() but can be lower.

Parameters

p (c4d.Vector) – The evaluation point.
rOctaves (float) – The octave.
rOffset (float) – The zero offset, this controls the multifractality.
rGain (float) – The amplification of the fractal value.
lRepeat (float) – Must be 2^x - 1, where x = [1..10], i.e. one of 1, 3, 7, 15, 31, 63, 127, 255, 511, and 1023. A noise repeats itself in time every 1024 units. Using a smaller lrepeat the noise will repeat at an earlier time.
t (float) – The time.

Return type

float

Returns

The fractal value.

C4DNoise.SNoise(self, p, lRepeat, t=0.0)¶

Generate a periodic signed noise value.

Parameters

p (c4d.Vector) – Noise coordinate.
lRepeat (int) – Must be 2^x - 1, where x = [1..10], i.e. one of 1, 3, 7, 15, 31, 63, 127, 255, 511, and 1023. A noise repeats itself in time every 1024 units. Using a smaller lRepeat the noise will repeat at an earlier time.
t (float) – The time.

Return type

float

Returns

Signed noise value, this is between -1.0 and 1.0.

C4DNoise.Turbulence(self, p, rOctaves, bAsolute, lRepeat, t=0.0)¶

Generate a turbulence value, this is a sum of multiple noises with different frequency.

Parameters

p (c4d.Vector) – Turbulence coordinate
rOctaves (float) – The number of octaves.
bAbsolute (bool) – True for absolute values.
lRepeat (int) – Must be 2^x - 1, where x = [1..10], i.e. one of 1, 3, 7, 15, 31, 63, 127, 255, 511, and 1023. A noise repeats itself in time every 1024 units. Using a smaller lRepeat the noise will repeat at an earlier time.
t (float) – The time.

Return type

float

Returns

Noise sample.

Noise Setup¶

C4DNoise.InitFbm(self, lMaxOctaves, rLacunarity, h)¶

Initializes fractal brownian motion.

Parameters

lMaxOctaves (int) – The maximum octave.
rLacunarity (float) – This parameter controls the scale of each successive fractal overlay.
h (float) – H-Parameter

Return type

bool

Returns

Initializes fractal brownian motion

Category	Option	Description
Query	Words and phrases	Search is case-insensitive. Put a phrase in quotes for an exact match. Quoted phrases require every word and disable fuzzy matching.
Terms	OR / AND	Choose whether to match any term or require all terms.
Fuzzy	On / Off	Toggle approximate and prefix matches. Quoted phrases always use strict matching.
Results	Sparse / Dense	Sparse groups multiple hits for one entity and hides its owned API members when the class or module itself matches. Dense lists each match separately.
Sort by	Type / Relevance	Group results by entity type then rank within each group, or rank all results by relevance.
Content	All / API / Manuals / Examples / Resources	Search all documentation, API documentation, manuals, the examples index, or the resources index. Code examples embedded in other sections retain their own content area.
Entity	All / Page / Module / Class / Function / Attribute / Description / Node / Symbol / Icon	Page covers results without a specific entity type. Resource entity types are available with All or Resources; API entity types are available with All or API.
Location	All / Text / Code / Name / Signature	Text covers everything outside code, names, and signatures. Name and Signature are available with All or API.