Struct SCNMaterialProperty 

#[repr(C)]
pub struct SCNMaterialProperty { /* private fields */ }

Available on crate feature SCNMaterialProperty only.

The contents of a SCNMaterial slot

This can be used to specify the various properties of SCNMaterial slots such as diffuse, ambient, etc.

See also Apple’s documentation

Implementations

impl SCNMaterialProperty

pub unsafe fn materialPropertyWithContents( contents: &AnyObject, ) -> Retained<Self>

Creates and initialize a property instance with the specified contents.

pub unsafe fn contents(&self) -> Option<Retained<AnyObject>>

Specifies the receiver’s contents. This can be a color (NSColor, UIColor, CGColorRef), an image (NSImage, UIImage, CGImageRef), a layer (CALayer), a path (NSString or NSURL), a SpriteKit scene (SKScene), a texture (SKTexture, id <MTLTexture

or GLKTextureInfo), or a floating value between 0 and 1 (NSNumber) for metalness and roughness properties. AVCaptureDevice is supported on iOS 11 and AVPlayer is supported on macOS 10.13, iOS 11 and tvOS 11. Animatable when set to a color.

Setting the contents to an instance of SKTexture will automatically update the wrapS, wrapT, contentsTransform, minification, magnification and mip filters according to the SKTexture settings. When a cube map is expected (e.g. SCNMaterial.reflective, SCNScene.background, SCNScene.lightingEnvironment) you can use

1. A horizontal strip image where 6 * image.height == image.width
2. A vertical strip image where image.height == 6 * image.width
3. A spherical projection image (latitude/longitude) where 2 * image.height == image.width
4. A NSArray of 6 images. This array must contain images of the exact same dimensions, in the following order, in a left-handed coordinate system: +X, -X, +Y, -Y, +Z, -Z (or Right, Left, Top, Bottom, Front, Back).

pub unsafe fn setContents(&self, contents: Option<&AnyObject>)

Setter for contents.

pub unsafe fn intensity(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Determines the receiver’s intensity. This intensity is used to modulate the properties in several ways. It dims the diffuse, specular and emission properties, it varies the bumpiness of the normal property and the filter property is blended with white. Default value is 1.0. Animatable.

pub unsafe fn setIntensity(&self, intensity: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for intensity.

pub unsafe fn minificationFilter(&self) -> SCNFilterMode

Specifies the filter type to use when rendering the contents (specified in the `contents’ property).

The minification filter is used when to reduce the size of image data. See above the list of available modes. Defaults to SCNFilterModeLinear.

pub unsafe fn setMinificationFilter(&self, minification_filter: SCNFilterMode)

Setter for minificationFilter.

pub unsafe fn magnificationFilter(&self) -> SCNFilterMode

Specifies the filter type to use when rendering the the contents (specified in the `contents’ property).

The magnification filter is used when to increase the size of image data. See above the list of available modes. Defaults to SCNFilterModeLinear.

pub unsafe fn setMagnificationFilter(&self, magnification_filter: SCNFilterMode)

Setter for magnificationFilter.

pub unsafe fn mipFilter(&self) -> SCNFilterMode

Specifies the mipmap filter to use during minification.

Defaults to SCNFilterModeNearest starting macOS 10.12, iOS 10, tvOS 10 and watchOS 3. Defaults to SCNFilterModeNone in previous versions.

pub unsafe fn setMipFilter(&self, mip_filter: SCNFilterMode)

Setter for mipFilter.

pub unsafe fn contentsTransform(&self) -> SCNMatrix4

Available on crate feature SceneKitTypes and crate feature objc2-quartz-core and non-watchOS only.

Determines the receiver’s contents transform. Animatable.

pub unsafe fn setContentsTransform(&self, contents_transform: SCNMatrix4)

Available on crate feature SceneKitTypes and crate feature objc2-quartz-core and non-watchOS only.

Setter for contentsTransform.

pub unsafe fn wrapS(&self) -> SCNWrapMode

Determines the receiver’s wrap mode for the s texture coordinate. Defaults to SCNWrapModeClamp.

pub unsafe fn setWrapS(&self, wrap_s: SCNWrapMode)

Setter for wrapS.

pub unsafe fn wrapT(&self) -> SCNWrapMode

Determines the receiver’s wrap mode for the t texture coordinate. Defaults to SCNWrapModeClamp.

pub unsafe fn setWrapT(&self, wrap_t: SCNWrapMode)

Setter for wrapT.

pub unsafe fn mappingChannel(&self) -> NSInteger

Determines the receiver’s mapping channel. Defaults to 0.

Geometries potentially have multiple sources of texture coordinates. Every source has a unique mapping channel index. The mapping channel allows to select which source of texture coordinates is used to map the content of the receiver.

pub unsafe fn setMappingChannel(&self, mapping_channel: NSInteger)

Setter for mappingChannel.

pub unsafe fn textureComponents(&self) -> SCNColorMask

Available on crate feature SceneKitTypes only.

Specifies the texture components to sample in the shader. Defaults to SCNColorMaskRed for displacement property, and to SCNColorMaskAll for other properties.

Use this property to when using a texture that combine multiple informations in the different texture components. For example if you pack the roughness in red and metalness in blue etc… You can specify what component to use from the texture for this given material property. This property is only supported by Metal renderers.

pub unsafe fn setTextureComponents(&self, texture_components: SCNColorMask)

Available on crate feature SceneKitTypes only.

Setter for textureComponents.

pub unsafe fn maxAnisotropy(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Specifies the receiver’s max anisotropy. Defaults to MAXFLOAT.

Anisotropic filtering reduces blur and preserves detail at extreme viewing angles.

pub unsafe fn setMaxAnisotropy(&self, max_anisotropy: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for maxAnisotropy.

pub unsafe fn precomputedLightingEnvironmentContentsWithURL_error( url: &NSURL, ) -> Result<Retained<AnyObject>, Retained<NSError>>

Returns an object suitable for a scene’s lightingEnvironment.contents and initialized with data that was previously created by +precomputedLightingEnvironmentDataForContents:device:error:.

pub unsafe fn precomputedLightingEnvironmentContentsWithData_error( data: &NSData, ) -> Result<Retained<AnyObject>, Retained<NSError>>

Returns an object suitable for a scene’s lightingEnvironment.contents and initialized with data that was previously created by +precomputedLightingEnvironmentDataForContents:device:error:.

pub unsafe fn precomputedLightingEnvironmentDataForContents_device_error( contents: &AnyObject, device: Option<&ProtocolObject<dyn MTLDevice>>, ) -> Result<Retained<NSData>, Retained<NSError>>

Available on crate feature objc2-metal and non-watchOS only.

Returns an NSData instance containing the result of CPU and GPU-intensive operations that is suitable for caching.

This method can be leveraged in a custom offline asset pipeline, or at run time at a convenient time before the scene is presented to the user.

impl SCNMaterialProperty

Methods declared on superclass NSObject.

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

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

impl SCNMaterialProperty

SCNDeprecated.

pub unsafe fn borderColor(&self) -> Option<Retained<AnyObject>>

👎Deprecated: Deprecated

Available on crate feature SceneKitDeprecated only.

Determines the receiver’s border color (CGColorRef or NSColor). Animatable.

The border color is ignored on iOS and is always considered as clear color (0,0,0,0) when the texture has an alpha channel and opaque back (0,0,0,1) otherwise.

pub unsafe fn setBorderColor(&self, border_color: Option<&AnyObject>)

👎Deprecated: Deprecated

Available on crate feature SceneKitDeprecated only.

Setter for borderColor.

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 SCNMaterialProperty

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SCNMaterialProperty

fn as_ref(&self) -> &NSObject

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

impl AsRef<SCNMaterialProperty> for SCNMaterialProperty

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCNMaterialProperty

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCNMaterialProperty

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SCNMaterialProperty

const NAME: &'static str = "SCNMaterialProperty"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<SCNMaterialProperty 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 SCNMaterialProperty

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

Formats the value using the given formatter.

impl Deref for SCNMaterialProperty

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCNMaterialProperty

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 SCNMaterialProperty

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SCNMaterialProperty

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

impl NSObjectProtocol for SCNMaterialProperty

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 NSSecureCoding for SCNMaterialProperty

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SCNMaterialProperty

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 SCNMaterialProperty

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

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

impl SCNAnimatable for SCNMaterialProperty

unsafe fn addAnimation_forKey( &self, animation: &ProtocolObject<dyn SCNAnimationProtocol>, key: Option<&NSString>, )

where Self: Sized + Message,

Available on crate feature SCNAnimation only.

Adds and runs an animation

unsafe fn addAnimationPlayer_forKey( &self, player: &SCNAnimationPlayer, key: Option<&NSString>, )

where Self: Sized + Message,

Available on crate feature SCNAnimation only.

Add an animation player.

unsafe fn removeAllAnimations(&self)

where Self: Sized + Message,

Available on crate feature SCNAnimation only.

Remove all animations.

unsafe fn removeAllAnimationsWithBlendOutDuration(&self, duration: CGFloat)

where Self: Sized + Message,

Available on crate features SCNAnimation and objc2-core-foundation only.

Smoothly remove all animations.

unsafe fn removeAnimationForKey(&self, key: &NSString)

where Self: Sized + Message,

Available on crate feature SCNAnimation only.

Remove the animation with the given identifier.

unsafe fn removeAnimationForKey_blendOutDuration( &self, key: &NSString, duration: CGFloat, )

where Self: Sized + Message,

Available on crate features SCNAnimation and objc2-core-foundation only.

Smoothly remove the animation with the given identifier.

unsafe fn animationKeys(&self) -> Retained<NSArray<NSString>>

where Self: Sized + Message,

Available on crate feature SCNAnimation only.

Returns an array containing the keys of all animations currently attached to the receiver.

unsafe fn animationPlayerForKey( &self, key: &NSString, ) -> Option<Retained<SCNAnimationPlayer>>

where Self: Sized + Message,

Available on crate feature SCNAnimation only.

Returns the animation player with the given identifier

unsafe fn removeAnimationForKey_fadeOutDuration( &self, key: &NSString, duration: CGFloat, )

where Self: Sized + Message,

👎Deprecated

Available on crate features SCNAnimation and objc2-core-foundation only.

Smoothly remove the animation with the given identifier.

unsafe fn animationForKey( &self, key: &NSString, ) -> Option<Retained<CAAnimation>>

where Self: Sized + Message,

👎Deprecated

Available on crate feature objc2-quartz-core and non-watchOS and crate feature SCNAnimation only.

Returns the animation with the given identifier

unsafe fn pauseAnimationForKey(&self, key: &NSString)

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer setPaused:] instead

Available on crate feature SCNAnimation only.

Pause the animation with the given identifier.

unsafe fn resumeAnimationForKey(&self, key: &NSString)

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer setPaused:] instead

Available on crate feature SCNAnimation only.

Resume the animation with the given identifier.

unsafe fn setSpeed_forAnimationKey(&self, speed: CGFloat, key: &NSString)

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer setSpeed:] instead

Available on crate features SCNAnimation and objc2-core-foundation only.

Update the animation speed of the animation with the given identifier.

unsafe fn isAnimationForKeyPaused(&self, key: &NSString) -> bool

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer paused] instead

Available on crate feature SCNAnimation only.

Returns whether the animation for the specified identifier is paused.

impl DowncastTarget for SCNMaterialProperty

impl Eq for SCNMaterialProperty