Struct SCNSceneSource

Source

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

Available on crate feature SCNSceneSource only.

Expand description

SCNSceneSource objects, abstract the data-reading task. A scene source can read scene data from a URL or a NSData object. After creating a SCNSceneSource object for the appropriate source, you can obtain scenes using SCNSceneSource methods.

Implementations§

Source §

impl SCNSceneSource

Source

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

Creates and initialize a SCNSceneSource instance.

Parameter url: The URL to read scenes from.

Parameter options: An optional dictionary for future extensions.

Source

pub unsafe fn sceneSourceWithData_options( data: &NSData, options: Option<&NSDictionary<SCNSceneSourceLoadingOption, AnyObject>>, ) -> Option<Retained<Self>>

Creates and initialize a SCNSceneSource instance.

Parameter data: The scene data.

Parameter options: An optional dictionary for future extensions.

Source

pub unsafe fn initWithURL_options( this: Allocated<Self>, url: &NSURL, options: Option<&NSDictionary<SCNSceneSourceLoadingOption, AnyObject>>, ) -> Option<Retained<Self>>

Initialize a SCNSceneSource instance from a URL.

Parameter url: The URL to read scenes from.

Parameter options: An optional dictionary for future extensions.

Source

pub unsafe fn initWithData_options( this: Allocated<Self>, data: &NSData, options: Option<&NSDictionary<SCNSceneSourceLoadingOption, AnyObject>>, ) -> Option<Retained<Self>>

Initialize a SCNSceneSource instance from a NSData object.

Parameter data: The data to read scenes from.

Parameter options: An optional dictionary for future extensions.

Source

pub unsafe fn url(&self) -> Option<Retained<NSURL>>

The receiver’s URL (if any).

Source

pub unsafe fn data(&self) -> Option<Retained<NSData>>

The receiver’s data (if any).

Source

pub unsafe fn sceneWithOptions_statusHandler( &self, options: Option<&NSDictionary<SCNSceneSourceLoadingOption, AnyObject>>, status_handler: SCNSceneSourceStatusHandler, ) -> Option<Retained<SCNScene>>

Available on crate features SCNScene and block2 only.

Creates and initializes the scene described in the 3D file with the specified options and lets you monitor the progress.

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

Parameter statusHandler: This block will be called repeatedly while the scene is being loaded.

The first argument, overallProgress, is a floating-point number between 0 and 1. 0 means the loading process has just started and 1 that it is complete.
The second argument, status, tells you what the source is currently doing. It takes one of the values in the SCNSceneSourceStatus enum. New values might be added to this enum in the future.
If status == SCNSceneStatusError, then error will contain more information about the failure, and the method will return nil after having called the block. Otherwise error will be nil.
Set *stop to YES if you want the source to abort the loading operation.

Source

pub unsafe fn sceneWithOptions_error( &self, options: Option<&NSDictionary<SCNSceneSourceLoadingOption, AnyObject>>, ) -> Result<Retained<SCNScene>, Retained<NSError>>

Available on crate feature SCNScene only.

Creates and initializes the scene described in the 3D file with the specified options.

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

Parameter error: If this method returns nil, an error providing more information is returned by reference.

This simpler version is equivalent to providing a block to sceneWithOptions:statusHandler: and checking the “error” parameter of the block if the status is SCNSceneStatusError.

Source

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

Parameter key: The key for which to return the corresponding property.

Returns the property as defined in the 3D file for the given key. See keys above.

Source

pub unsafe fn entryWithIdentifier_withClass( &self, uid: &NSString, entry_class: &AnyClass, ) -> Option<Retained<AnyObject>>

Returns the instance of “entryClass” found in the receiver’s library with the id “uid”.

Parameter uid: The id of the entry to find as specified in the source file

Parameter entryClass: Specifies the type of the object to be returned. It can be one of the following classes: SCNMaterial, SCNGeometry, SCNScene, SCNNode, CAAnimation, SCNLight, SCNCamera, SCNSkinner, SCNMorpher, NSImage

Returns NULL if the receiver’s library doesn’t contains such an uid for the specified type.

Source

pub unsafe fn identifiersOfEntriesWithClass( &self, entry_class: &AnyClass, ) -> Retained<NSArray<NSString>>

Returns the IDs found in the receiver’s library for the class “entryClass”.

Parameter entryClass: Specifies the type of the object referenced by the returned IDs. It can be one of the following classes: SCNMaterial, SCNScene, SCNGeometry, SCNNode, CAAnimation, SCNLight, SCNCamera, SCNSkinner, SCNMorpher, NSImage

Source

pub unsafe fn entriesPassingTest( &self, predicate: &Block<dyn Fn(NonNull<AnyObject>, NonNull<NSString>, NonNull<Bool>) -> Bool + '_>, ) -> Retained<NSArray<AnyObject>>

Available on crate feature block2 only.

Returns the entries in the receiver’s library that pass a test in a given Block.

Parameter predicate: The block to apply to entries in the library. The block takes three arguments: “entry” is an entry in the library, “identifier” is the ID of this entry and “stop” is a reference to a Boolean value. The block can set the value to YES to stop further processing of the library. The stop argument is an out-only argument. You should only ever set this Boolean to YES within the Block. The Block returns a Boolean value that indicates whether “entry” passed the test.

The entry is an instance of one of following classes: SCNMaterial, SCNScene, SCNGeometry, SCNNode, CAAnimation, SCNLight, SCNCamera, SCNSkinner, SCNMorpher, NSImage.

Source §

impl SCNSceneSource

Methods declared on superclass NSObject.

Source

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

Source

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

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}