Struct SCNScene

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

Available on crate feature SCNScene only.

SCNScene is the class that describes a 3d scene. It encapsulates a node hierarchy.

See also Apple’s documentation

Implementations

impl SCNScene

SCNModelIO. ModelIO.h

Bridge with the Model I/O framework

pub unsafe fn sceneWithMDLAsset(mdl_asset: &MDLAsset) -> Retained<Self>

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

impl SCNScene

SCNParticleSystemSupport.

pub unsafe fn addParticleSystem_withTransform( &self, system: &SCNParticleSystem, transform: SCNMatrix4, )

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

pub unsafe fn removeAllParticleSystems(&self)

Available on crate feature SCNParticleSystem only.

pub unsafe fn removeParticleSystem(&self, system: &SCNParticleSystem)

Available on crate feature SCNParticleSystem only.

pub unsafe fn particleSystems( &self, ) -> Option<Retained<NSArray<SCNParticleSystem>>>

Available on crate feature SCNParticleSystem only.

impl SCNScene

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

pub unsafe fn rootNode(&self) -> Retained<SCNNode>

Available on crate feature SCNNode only.

Specifies the root node of the node hierarchy.

Note that we have only one root node, whereas some file formats might have many nodes at the root of their hierarchies. The root node(s) of the imported files will therefore be children of the SCNScene’s root node.

pub unsafe fn physicsWorld(&self) -> Retained<SCNPhysicsWorld>

Available on crate feature SCNPhysicsWorld only.

Specifies the physics world of the receiver.

Every scene automatically creates a physics world object to simulate physics on nodes in the scene. You use this property to access the scene’s global physics properties, such as gravity. To add physics to a particular node, see physicsBody.

pub unsafe fn attributeForKey( &self, key: &NSString, ) -> Option<Retained<AnyObject>>

Retrieves a scene attribute.

The available keys are listed in the “Scene attributes” group.

Parameter key: An NSString object that specifies the attribute to be read

pub unsafe fn setAttribute_forKey( &self, attribute: Option<&AnyObject>, key: &NSString, )

Sets a scene attribute

The available keys are listed in the “Scene attributes” group.

Parameter attribute: An object that specifies the value of the attribute to be written.

Parameter key: An NSString object that specifies the attribute to be written

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

Available on crate feature SCNMaterialProperty only.

Specifies the background of the receiver.

The background is rendered before the rest of the scene. The background can be rendered as a skybox by setting a cube map as described in SCNMaterialProperty.h Colors are supported starting in macOS 10.12 and iOS 10. Prior to that you can use SCNView.backgroundColor. MDLSkyCubeTexture is supported starting in macOS 10.13 and iOS 11.

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

Available on crate feature SCNMaterialProperty only.

Specifies the receiver’s environment for image-based lighting (IBL).

The environment can be

• a cube map (as described in SCNMaterialProperty.h)
• an instance of MDLSkyCubeTexture (supported since macOS 10.13 and iOS 11)
• an object returned by +[SCNMaterialProperty precomputedLightingEnvironmentContentsWithURL:error:] or +[SCNMaterialProperty precomputedLightingEnvironmentContentsWithData:error:]

pub unsafe fn sceneNamed(name: &NSString) -> Option<Retained<Self>>

Creates and returns a scene associated with the specified filename.

Parameter name: The name of the file. The method looks for a file with the specified name in the application’s main bundle.

This method initializes with no options and does not check for errors. The resulting object is not cached.

pub unsafe fn sceneNamed_inDirectory_options( name: &NSString, directory: Option<&NSString>, options: Option<&NSDictionary<SCNSceneSourceLoadingOption, AnyObject>>, ) -> Option<Retained<Self>>

Available on crate feature SCNSceneSource only.

Creates and returns a scene associated with the specified filename.

Parameter name: The name of the file. The method looks for a file with the specified name in the application’s main bundle.

Parameter directory: The name of the bundle sub-directory to search into.

Parameter options: An options dictionary. The relevant keys are documented in the SCNSceneSource class.

This method initializes with no options and does not check for errors. The resulting object is not cached.

pub unsafe fn sceneWithURL_options_error( url: &NSURL, options: Option<&NSDictionary<SCNSceneSourceLoadingOption, AnyObject>>, ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate feature SCNSceneSource only.

Creates and returns a scene from the specified URL.

Parameter url: The URL to the 3D file.

Parameter options: An options dictionary. The relevant keys are documented in the SCNSceneSource class.

Parameter error: A NSError object passed by reference to get more information about the error when a nil is returned.

This method is here for convenience. It is equivalent to initializing a SCNSceneSource with the specified url and options, and asking it for its scene with the same options.

pub unsafe fn writeToURL_options_delegate_progressHandler( &self, url: &NSURL, options: Option<&NSDictionary<NSString, AnyObject>>, delegate: Option<&ProtocolObject<dyn SCNSceneExportDelegate>>, progress_handler: SCNSceneExportProgressHandler, ) -> bool

Available on crate feature block2 only.

write the scene to the specified url.

Parameter url: the destination url to write the scene to.

Parameter options: A dictionary of options. The valid keys are described in the “Scene writing options” section.

Parameter delegate: an optional delegate to manage external references such as images.

Parameter progressHandler: an optional block to handle the progress of the operation.

Returns: Returns YES if the operation succeeded, NO otherwise. Errors checking can be done via the “error” parameter of the ‘progressHandler’.

macOS 10.10 and lower only supports exporting to .dae files. Starting macOS 10.11 exporting supports .dae, .scn as well as file all formats supported by Model I/O. Starting iOS 10 exporting supports .scn as well as all file formats supported by Model I/O.

pub unsafe fn fogStartDistance(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Specifies the receiver’s fog start distance. Animatable. Defaults to 0.

pub unsafe fn setFogStartDistance(&self, fog_start_distance: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for fogStartDistance.

pub unsafe fn fogEndDistance(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Specifies the receiver’s fog end distance. Animatable. Defaults to 0.

pub unsafe fn setFogEndDistance(&self, fog_end_distance: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for fogEndDistance.

pub unsafe fn fogDensityExponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Specifies the receiver’s fog power exponent. Animatable. Defaults to 1.

Controls the attenuation between the start and end fog distances. 0 means a constant fog, 1 a linear fog and 2 a quadratic fog, but any positive value will work.

pub unsafe fn setFogDensityExponent(&self, fog_density_exponent: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for fogDensityExponent.

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

Specifies the receiver’s fog color (NSColor or CGColorRef). Animatable. Defaults to white.

The initial value is a NSColor.

pub unsafe fn setFogColor(&self, fog_color: &AnyObject)

Setter for fogColor.

pub unsafe fn wantsScreenSpaceReflection(&self) -> bool

Determines if the scene use screen space reflection.

Defaults to NO.

pub unsafe fn setWantsScreenSpaceReflection( &self, wants_screen_space_reflection: bool, )

Setter for wantsScreenSpaceReflection.

pub unsafe fn screenSpaceReflectionSampleCount(&self) -> NSInteger

Determines the sample count of the screen space reflection.

Defaults to 64.

pub unsafe fn setScreenSpaceReflectionSampleCount( &self, screen_space_reflection_sample_count: NSInteger, )

Setter for screenSpaceReflectionSampleCount.

pub unsafe fn screenSpaceReflectionMaximumDistance(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Determines the maximum distance in world units.

Defaults to 1000.

pub unsafe fn setScreenSpaceReflectionMaximumDistance( &self, screen_space_reflection_maximum_distance: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for screenSpaceReflectionMaximumDistance.

pub unsafe fn screenSpaceReflectionStride(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Raytracing step size in pixel. The lower the better, the higher the faster.

Defaults to 8.

pub unsafe fn setScreenSpaceReflectionStride( &self, screen_space_reflection_stride: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for screenSpaceReflectionStride.

pub unsafe fn isPaused(&self) -> bool

Controls whether or not the scene is paused. Defaults to NO.

Pausing a scene will pause animations, actions, particles and physics.

pub unsafe fn setPaused(&self, paused: bool)

Setter for isPaused.

impl SCNScene

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.

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 SCNScene

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SCNScene

fn as_ref(&self) -> &NSObject

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

impl AsRef<SCNScene> for SCNScene

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCNScene

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCNScene

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SCNScene

const NAME: &'static str = "SCNScene"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for SCNScene

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCNScene

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 SCNScene

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SCNScene

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSObjectProtocol for SCNScene

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 SCNScene

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SCNScene

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 SCNScene

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

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

impl DowncastTarget for SCNScene

impl Eq for SCNScene