Struct GKNoise 

pub struct GKNoise { /* private fields */ }

Available on crate feature GKNoise only.

GKNoise is the object used to manipulate and combine noise in continuous 3D space. It takes a GKNoiseSource as input. To extract and use a portion of the noise within the 3D space use the GKNoiseMap class.

See: GKNoiseSource

See: GKNoiseMap

See also Apple’s documentation

Implementations

impl GKNoise

pub unsafe fn gradientColors(&self) -> Retained<NSDictionary<NSNumber, NSColor>>

Available on crate feature objc2-app-kit and macOS only.

Color gradient of this noise, represented as ‘value : color’ pairs. Utilized when this noise is rendered to a texture.

pub unsafe fn setGradientColors( &self, gradient_colors: &NSDictionary<NSNumber, NSColor>, )

Available on crate feature objc2-app-kit and macOS only.

Setter for gradientColors.

This is copied when set.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Initializes a constant noise of 0.0 at all positions.

pub unsafe fn noiseWithNoiseSource( noise_source: &GKNoiseSource, ) -> Retained<Self>

Available on crate feature GKNoiseSource only.

Initializes a noise with the specified noise source.

Parameter noiseSource: The noise source to use to initially populate the 3D noise space.

pub unsafe fn noiseWithNoiseSource_gradientColors( noise_source: &GKNoiseSource, gradient_colors: &NSDictionary<NSNumber, NSColor>, ) -> Retained<Self>

Available on crate feature GKNoiseSource and crate feature objc2-app-kit and macOS only.

Initializes a noise with the specified noise source and parameters.

Parameter noiseSource: The noise source to use to initially populate the 3D noise space.

Parameter gradientColors: The color gradient to use for this noise in ‘value : color’ pairs.

pub unsafe fn initWithNoiseSource( this: Allocated<Self>, noise_source: &GKNoiseSource, ) -> Retained<Self>

Available on crate feature GKNoiseSource only.

Initializes a noise with the specified noise source.

Parameter noiseSource: The noise source to use to initially populate the 3D noise space.

pub unsafe fn initWithNoiseSource_gradientColors( this: Allocated<Self>, noise_source: &GKNoiseSource, gradient_colors: &NSDictionary<NSNumber, NSColor>, ) -> Retained<Self>

Available on crate feature GKNoiseSource and crate feature objc2-app-kit and macOS only.

Initializes a noise with the specified noise source and parameters.

Parameter noiseSource: The noise source to use to initially populate the 3D noise space.

Parameter gradientColors: The color gradient to use for this noise in ‘value : color’ pairs.

pub unsafe fn noiseWithComponentNoises_selectionNoise( noises: &NSArray<GKNoise>, selection_noise: &GKNoise, ) -> Retained<Self>

Initializes a composite noise from one or more component noises. Useful for combining and layering noises together.

Parameter noises: The component noises to combine.

Parameter selectionNoise: The noise that governs which component noise is chosen for each position of the resulting noise. The range of values is equally-subdivided for each component noise.

pub unsafe fn noiseWithComponentNoises_selectionNoise_componentBoundaries_boundaryBlendDistances( noises: &NSArray<GKNoise>, selection_noise: &GKNoise, component_boundaries: &NSArray<NSNumber>, blend_distances: &NSArray<NSNumber>, ) -> Retained<Self>

Initializes a composite noise from one or more component noises. Useful for combining and layering noises together.

Parameter noises: The component noises to combine.

Parameter selectionNoise: The noise that governs which component noise is chosen for each position of the resulting noise. The range of values is equally-subdivided for each component noise.

Parameter componentBoundaries: The noise value boundaries of the selection noise to use for the component noises. Specify one less boundary than the number of component noises. This is a parallel array to blendDistances.

Parameter blendDistances: The size of smoothing that is applied to boundaries where two component noises meet. Specify one less blend distance than the number of component noises. This is a parallel array to componentBoundaries.

pub unsafe fn applyAbsoluteValue(&self)

Takes the absoltue value of all noise positions.

pub unsafe fn clampWithLowerBound_upperBound( &self, lower_bound: c_double, upper_bound: c_double, )

Clamps all noise values to the specified bounds.

Parameter lowerBound: The noise value lower bound.

Parameter upperBound: The noise value upper bound.

pub unsafe fn raiseToPower(&self, power: c_double)

Raises all noise values to the specified power.

Parameter power: The power to which to raise all noise values.

pub unsafe fn invert(&self)

Inverts all noise values, from positive to negative and vice versa.

pub unsafe fn applyTurbulenceWithFrequency_power_roughness_seed( &self, frequency: c_double, power: c_double, roughness: c_int, seed: i32, )

Applies a turbulent displacement to all noise values.

pub unsafe fn remapValuesToCurveWithControlPoints( &self, control_points: &NSDictionary<NSNumber, NSNumber>, )

Remaps all noise values to a smooth curve that passes through the specified control points.

Parameter controlPoints: Pairs of ‘input : output’ values to use as control points for the smooth remapping curve. Duplicate input values are not permitted.

pub unsafe fn remapValuesToTerracesWithPeaks_terracesInverted( &self, peak_input_values: &NSArray<NSNumber>, inverted: bool, )

Remaps all noise values to one or more terraces with peaks. Useful for creating valleys and trenches.

Parameter peakInputValues: Inputs positions of terrace peaks.

Parameter inverted: Governs the curve direction from peak to peak.

pub unsafe fn addWithNoise(&self, noise: &GKNoise)

Adds all noise values by the noise values at the same position in specified noise.

Parameter noise: The noise from which to add values to this noise.

pub unsafe fn multiplyWithNoise(&self, noise: &GKNoise)

Multiplies all noise values by the noise values at the same position in specified noise.

Parameter noise: The noise from which to multiply values to this noise.

pub unsafe fn minimumWithNoise(&self, noise: &GKNoise)

Takes the minimum value between this noise and the specified noise at each position.

Parameter noise: The noise to compare against this noise at each position in determining which to take the minimum value from.

pub unsafe fn maximumWithNoise(&self, noise: &GKNoise)

Takes the maximum value between this noise and the specified noise at each position.

Parameter noise: The noise to compare against this noise at each position in determining which to take the maximum value from.

pub unsafe fn raiseToPowerWithNoise(&self, noise: &GKNoise)

Raises all noise values to the power of the value at the same position of the specified noise.

Parameter noise: The noise from which to raise this noise’s values by.

pub unsafe fn displaceXWithNoise_yWithNoise_zWithNoise( &self, x_displacement_noise: &GKNoise, y_displacement_noise: &GKNoise, z_displacement_noise: &GKNoise, )

Displaces all noise values by the values at the same positions of the specified noises.

Parameter xDisplacementNoise: The noise from which to displace along the x-axis this noise’s values at the same positions.

Parameter yDisplacementNoise: The noise from which to displace along the y-axis this noise’s values at the same positions.

Parameter zDisplacementNoise: The noise from which to displace along the z-axis this noise’s values at the same positions.

impl GKNoise

Methods declared on superclass NSObject.

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for GKNoise

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<GKNoise> for GKNoise

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for GKNoise

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for GKNoise

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for GKNoise

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for GKNoise

const NAME: &'static str = "GKNoise"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<GKNoise as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for GKNoise

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for GKNoise

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for GKNoise

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for GKNoise

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for GKNoise

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for GKNoise

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for GKNoise

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for GKNoise

impl Eq for GKNoise