Struct SCNMaterial 

pub struct SCNMaterial { /* private fields */ }

Available on crate feature SCNMaterial only.

A SCNMaterial determines how a geometry is rendered. It encapsulates the colors and textures that define the appearance of 3d geometries.

See also Apple’s documentation

Implementations

impl SCNMaterial

SCNModelIO.

pub unsafe fn materialWithMDLMaterial( mdl_material: &MDLMaterial, ) -> Retained<Self>

Available on crate feature ModelIO and crate feature objc2-model-io and non-watchOS only.

impl SCNMaterial

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

Creates and initialize a material instance.

pub unsafe fn name(&self) -> Option<Retained<NSString>>

Determines the name of the receiver.

pub unsafe fn setName(&self, name: Option<&NSString>)

Setter for name.

This is copied when set.

pub unsafe fn diffuse(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

Specifies the receiver’s diffuse property.

The diffuse property specifies the amount of light diffusely reflected from the surface. The diffuse light is reflected equally in all directions and is therefore independent of the point of view.

pub unsafe fn ambient(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

Specifies the receiver’s ambient property.

The ambient property specifies the amount of ambient light to reflect. This property has no visual impact on scenes that have no ambient light. Setting the ambient has no effect if locksAmbientWithDiffuse is set to YES.

pub unsafe fn specular(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

Specifies the receiver’s specular property.

The specular property specifies the amount of light to reflect in a mirror-like manner. The specular intensity increases when the point of view lines up with the direction of the reflected light.

pub unsafe fn emission(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

The emission property specifies the amount of light the material emits. This emission does not light up other surfaces in the scene.

pub unsafe fn transparent(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

The transparent property specifies the transparent areas of the material.

pub unsafe fn reflective(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

The reflective property specifies the reflectivity of the surface. The surface will not actually reflect other objects in the scene. This property may be used as a sphere mapping to reflect a precomputed environment.

pub unsafe fn multiply(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

The multiply property specifies a color or an image used to multiply the output fragments with. The computed fragments are multiplied with the multiply value to produce the final fragments. This property may be used for shadow maps, to fade out or tint 3d objects.

pub unsafe fn normal(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

The normal property specifies the surface orientation.

When an image is set on the normal property the material is automatically lit per pixel. Setting a color has no effect.

pub unsafe fn displacement(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

The displacement property specifies how vertex are translated in tangent space.

Pass a grayscale image for a simple ‘elevation’ or rgb image for a vector displacement.

pub unsafe fn ambientOcclusion(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

The ambientOcclusion property specifies the ambient occlusion of the surface. The ambient occlusion is multiplied with the ambient light, then the result is added to the lighting contribution. This property has no visual impact on scenes that have no ambient light. When an ambient occlusion map is set, the ambient property is ignored.

pub unsafe fn selfIllumination(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

The selfIllumination property specifies a texture or a color that is added to the lighting contribution of the surface. When a selfIllumination is set, the emission property is ignored.

pub unsafe fn metalness(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

The metalness property specifies how metallic the material’s surface appears. Lower values (darker colors) cause the material to appear more like a dielectric surface. Higher values (brighter colors) cause the surface to appear more metallic. This property is only used when ‘lightingModelName’ is ‘SCNLightingModelPhysicallyBased’.

pub unsafe fn roughness(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

The roughness property specifies the apparent smoothness of the surface. Lower values (darker colors) cause the material to appear shiny, with well-defined specular highlights. Higher values (brighter colors) cause specular highlights to spread out and the diffuse property of the material to become more retroreflective. This property is only used when ‘lightingModelName’ is ‘SCNLightingModelPhysicallyBased’.

pub unsafe fn clearCoat(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

The clearCoat property specifies color and intensity of the coat layer.

pub unsafe fn clearCoatRoughness(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

The clearCoat property specifies color and intensity of the coat roughness.

pub unsafe fn clearCoatNormal(&self) -> Retained<SCNMaterialProperty>

Available on crate feature SCNMaterialProperty only.

The clearCoatNormal property specifies color and intensity of the optional coat normal map.

pub unsafe fn shininess(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Specifies the receiver’s shininess value. Defaults to 1.0. Animatable.

pub unsafe fn setShininess(&self, shininess: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for shininess.

pub unsafe fn transparency(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Specifies the receiver’s transparency value. Defaults to 1.0. Animatable.

The color of the transparent property is multiplied by this property. The result is then used to produce the final transparency according to the rule defined by the transparencyMode property.

pub unsafe fn setTransparency(&self, transparency: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for transparency.

pub unsafe fn lightingModelName(&self) -> Retained<SCNLightingModel>

Determines the receiver’s lighting model. See above for the list of lighting models. Defaults to SCNLightingModelBlinn.

pub unsafe fn setLightingModelName( &self, lighting_model_name: &SCNLightingModel, )

Setter for lightingModelName.

This is copied when set.

pub unsafe fn isLitPerPixel(&self) -> bool

Determines whether the receiver is lit per pixel. Defaults to YES. Animatable.

pub unsafe fn setLitPerPixel(&self, lit_per_pixel: bool)

Setter for isLitPerPixel.

pub unsafe fn isDoubleSided(&self) -> bool

Determines whether the receiver is double sided. Defaults to NO. Animatable.

pub unsafe fn setDoubleSided(&self, double_sided: bool)

Setter for isDoubleSided.

pub unsafe fn fillMode(&self) -> SCNFillMode

Determines of to how to rasterize the receiver’s primitives. Defaults to SCNFillModeFill.

pub unsafe fn setFillMode(&self, fill_mode: SCNFillMode)

Setter for fillMode.

pub unsafe fn cullMode(&self) -> SCNCullMode

Determines the culling mode of the receiver. Defaults to SCNCullModeBack. Animatable.

pub unsafe fn setCullMode(&self, cull_mode: SCNCullMode)

Setter for cullMode.

pub unsafe fn transparencyMode(&self) -> SCNTransparencyMode

Determines the transparency mode of the receiver. See above for the transparency modes. Defaults to SCNTransparencyModeDefault.

pub unsafe fn setTransparencyMode(&self, transparency_mode: SCNTransparencyMode)

Setter for transparencyMode.

pub unsafe fn locksAmbientWithDiffuse(&self) -> bool

Makes the ambient property automatically match the diffuse property. Defaults to NO on 10.9 and before, defaults to YES otherwise. Animatable.

pub unsafe fn setLocksAmbientWithDiffuse( &self, locks_ambient_with_diffuse: bool, )

Setter for locksAmbientWithDiffuse.

pub unsafe fn writesToDepthBuffer(&self) -> bool

Determines whether the receiver writes to the depth buffer when rendered. Defaults to YES.

pub unsafe fn setWritesToDepthBuffer(&self, writes_to_depth_buffer: bool)

Setter for writesToDepthBuffer.

pub unsafe fn colorBufferWriteMask(&self) -> SCNColorMask

Available on crate feature SceneKitTypes only.

Determines whether the receiver writes to the color buffer when rendered. Defaults to SCNColorMaskAll.

pub unsafe fn setColorBufferWriteMask( &self, color_buffer_write_mask: SCNColorMask, )

Available on crate feature SceneKitTypes only.

Setter for colorBufferWriteMask.

pub unsafe fn readsFromDepthBuffer(&self) -> bool

Determines whether the receiver reads from the depth buffer when rendered. Defaults to YES.

pub unsafe fn setReadsFromDepthBuffer(&self, reads_from_depth_buffer: bool)

Setter for readsFromDepthBuffer.

pub unsafe fn fresnelExponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Specifies the receiver’s fresnel exponent value. Defaults to 0.0. Animatable.

The effect of the reflectivity property is modulated by this property. The fresnelExponent changes the exponent of the reflectance. The bigger the exponent, the more concentrated the reflection is around the edges.

pub unsafe fn setFresnelExponent(&self, fresnel_exponent: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for fresnelExponent.

pub unsafe fn blendMode(&self) -> SCNBlendMode

Specifies the receiver’s blend mode. Defaults to SCNBlendModeAlpha.

pub unsafe fn setBlendMode(&self, blend_mode: SCNBlendMode)

Setter for blendMode.

impl SCNMaterial

Methods declared on superclass NSObject.

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

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 SCNMaterial

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SCNMaterial

fn as_ref(&self) -> &NSObject

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

impl AsRef<SCNMaterial> for SCNMaterial

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCNMaterial

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCNMaterial

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SCNMaterial

const NAME: &'static str = "SCNMaterial"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<SCNMaterial 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 CopyingHelper for SCNMaterial

type Result = SCNMaterial

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for SCNMaterial

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

Formats the value using the given formatter.

impl Deref for SCNMaterial

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCNMaterial

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 SCNMaterial

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SCNMaterial

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

impl NSCopying for SCNMaterial

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for SCNMaterial

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 SCNMaterial

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SCNMaterial

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 SCNMaterial

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

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

impl SCNAnimatable for SCNMaterial

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 SCNAnimation and crate feature objc2-quartz-core and non-watchOS 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 SCNShadable for SCNMaterial

unsafe fn program(&self) -> Option<Retained<SCNProgram>>

where Self: Sized + Message,

Available on crate feature SCNShadable only.

Specifies a custom program used to render the receiver.

unsafe fn setProgram(&self, program: Option<&SCNProgram>)

where Self: Sized + Message,

Available on crate feature SCNShadable only.

Setter for program.

unsafe fn handleBindingOfSymbol_usingBlock( &self, symbol: &NSString, block: SCNBindingBlock, )

where Self: Sized + Message,

Available on crate features SCNShadable and SCNNode and SCNRenderer and block2 only.

Sets the block to call at render time to bind the value for the specified symbol of the receiver’s SCNProgram. This method has no effect for symbols declared in shader modifiers.

unsafe fn handleUnbindingOfSymbol_usingBlock( &self, symbol: &NSString, block: SCNBindingBlock, )

where Self: Sized + Message,

Available on crate features SCNShadable and SCNNode and SCNRenderer and block2 only.

Sets the block to call at render time to unbind the value for the specified symbol of the receiver’s SCNProgram. This method has no effect for symbols declared in shader modifiers.

unsafe fn shaderModifiers( &self, ) -> Option<Retained<NSDictionary<SCNShaderModifierEntryPoint, NSString>>>

where Self: Sized + Message,

Available on crate feature SCNShadable only.

Dictionary of shader modifiers snippets, targeting entry points. The valid keys are the entry points described in the “Shader Modifier Entry Point” constants. The values are the code snippets formatted as described below.

unsafe fn setShaderModifiers( &self, shader_modifiers: Option<&NSDictionary<SCNShaderModifierEntryPoint, NSString>>, )

where Self: Sized + Message,

Available on crate feature SCNShadable only.

Setter for shaderModifiers.

unsafe fn minimumLanguageVersion(&self) -> Option<Retained<NSNumber>>

where Self: Sized + Message,

Available on crate feature SCNShadable only.

The minimum language version required to interpret the shadable source code (wrapped MTLLanguageVersion). Defaults to nil.

unsafe fn setMinimumLanguageVersion( &self, minimum_language_version: Option<&NSNumber>, )

where Self: Sized + Message,

Available on crate feature SCNShadable only.

Setter for minimumLanguageVersion.

impl DowncastTarget for SCNMaterial

impl Eq for SCNMaterial