Struct MDLAsset 

pub struct MDLAsset { /* private fields */ }

Available on crate feature MDLAsset only.

An MDLAsset represents the contents of a model file.

Each asset contains a collection of hierarchies of objects, where each object in the asset is the top level of a hierarchy. Objects include transforms, lights, cameras, and meshes.

MDLAssets are typically instantiated from NSURLs that refer to a model resource.

The model resource may represented timed information, for example, a series of mesh morphs. If the asset is timed, then the framerate will be non-zero, and the firstFrame and lastFrame properties will indicate the range for which sample data exists. Samples before or after that range will be clamped. Some model resource representations allow continuous sampling, others are discrete. In the discrete case, if a requested sample time is not on a discrete boundary the returned sample will be the sample exactly on the sample time, or if no such is available, the immediately preceding sample. If no time is specified for a sample, the first data will be returned.

An asset’s bounding box can be queried without traversing the hierarchy of objects.

Fast enumeration of an MDLAsset iterates the top level objects contained within.

See also Apple’s documentation

Implementations

impl MDLAsset

pub unsafe fn initWithURL(this: Allocated<Self>, url: &NSURL) -> Retained<Self>

Initialize an MDLAsset using the contents of the resource located at the indicated URL

Vertex layout (i.e. vertexDescriptor) will be specified by ModelIO depending on attributes of the resource. Buffers will be allocated using a default NSData based allocator

Submeshes will be converted to triangle topology.

pub unsafe fn initWithURL_vertexDescriptor_bufferAllocator( this: Allocated<Self>, url: Option<&NSURL>, vertex_descriptor: Option<&MDLVertexDescriptor>, buffer_allocator: Option<&ProtocolObject<dyn MDLMeshBufferAllocator>>, ) -> Retained<Self>

Available on crate features MDLMeshBuffer and MDLVertexDescriptor only.

Initialize an MDLAsset using the contents of the resource located at URL, ensuring that the asset conforms to the supplied vertexDescriptor, and buffers are allocated in the supplied allocator

The default behavior is to triangulate any discovered meshes and to conform the mesh to the supplied vertexDescriptor.

If nil is passed as the vertexDescriptor, then a vertexDescriptor will be created according to the attributes of the resource.

If nil is passed as the bufferAllocator, buffers will be allocated using a default NSData based allocator.

Submeshes will be converted to triangle topology.

pub unsafe fn initWithBufferAllocator( this: Allocated<Self>, buffer_allocator: Option<&ProtocolObject<dyn MDLMeshBufferAllocator>>, ) -> Retained<Self>

Available on crate feature MDLMeshBuffer only.

Initialize an empty MDLAsset with a buffer allocator to be used during other operations.

pub unsafe fn initWithURL_vertexDescriptor_bufferAllocator_preserveTopology_error( this: Allocated<Self>, url: &NSURL, vertex_descriptor: Option<&MDLVertexDescriptor>, buffer_allocator: Option<&ProtocolObject<dyn MDLMeshBufferAllocator>>, preserve_topology: bool, error: Option<&mut Option<Retained<NSError>>>, ) -> Retained<Self>

Available on crate features MDLMeshBuffer and MDLVertexDescriptor only.

Same as initWithURL:vertexDescriptor:bufferAllocator: except that if preserveTopology is YES, a topology buffer might be created on the submeshes.

If all faces in a submesh have the same vertex count, then the submesh will a geometry type corresponding to that vertex count. For example, if all faces have four vertices, then the geometry type will be MDLGeometryTypeQuads. If faces have a varying number of vertices, then the the submesh type will be MDLGeometryTypeVariableTopology, and a faceTopologyBuffer will be created.

pub unsafe fn exportAssetToURL(&self, url: &NSURL) -> bool

Export an asset to the specified URL.

Returns: YES is returned if exporting proceeded successfully,

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

Export an asset to the specified URL.

Returns: YES is returned if exporting proceeded successfully,

pub unsafe fn objectAtPath(&self, path: &NSString) -> Retained<MDLObject>

Available on crate feature MDLObject only.

Return the object at the specified path, or nil if none exists there

pub unsafe fn canImportFileExtension(extension: &NSString) -> bool

Indicates whether MDLAsset object can be initialized with resource with the given extension

Returns: YES is returned if MDLAsset is able to load and represent assets with the given extension

pub unsafe fn canExportFileExtension(extension: &NSString) -> bool

Indicates whether MDLAsset object can export asset to resource with the given extension

Returns: YES is returned if MDLAsset is able is able to export assets to resources with the given extension

pub unsafe fn childObjectsOfClass( &self, object_class: &AnyClass, ) -> Retained<NSArray<MDLObject>>

Available on crate feature MDLObject only.

Inspects an asset’s hierarchy for objects of the specified class type

Returns: returns an NSArray of all objects in the asset matching the requested class

This can be used to get references to all MDLMesh objects, MDLLights, etc. if objectClass is not a subclass of MDLObject, an exception will be raised.

Safety

object_class probably has further requirements.

pub unsafe fn loadTextures(&self)

Iterates over all material properties on all materials. If they are string values or NSURL values, and can be resolved as textures, then the string and NSURL values will be replaced by MDLTextureSampler values.

pub unsafe fn frameInterval(&self) -> NSTimeInterval

Inherent frame rate of an asset

If no framerate was specified by resource or resource uncapable of specifying framerate, this value defaults to 0

pub unsafe fn setFrameInterval(&self, frame_interval: NSTimeInterval)

Setter for frameInterval.

pub unsafe fn startTime(&self) -> NSTimeInterval

Start time bracket of animation data

If no animation data was specified by resource or resource incapable of specifying animation data, this value defaults to 0. If startTime was set explicitly, then the value of startTime will be the lesser of the set value and the animated values.

pub unsafe fn setStartTime(&self, start_time: NSTimeInterval)

Setter for startTime.

pub unsafe fn endTime(&self) -> NSTimeInterval

End time bracket of animation data

If no animation data was specified by resource or resource incapable of specifying animation data, this value defaults to 0. If the endTime was set explicitly, then the value of endTime will be the greater of the set value and the animated values.

pub unsafe fn setEndTime(&self, end_time: NSTimeInterval)

Setter for endTime.

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

URL used to create the asset

If the asset was not created with a URL, nil will be returned.

pub unsafe fn resolver( &self, ) -> Option<Retained<ProtocolObject<dyn MDLAssetResolver>>>

Available on crate feature MDLAssetResolver only.

Resolver asset that helps find associated files

The default asset resolver is the RelativeAssetResolver

pub unsafe fn setResolver( &self, resolver: Option<&ProtocolObject<dyn MDLAssetResolver>>, )

Available on crate feature MDLAssetResolver only.

Setter for resolver.

pub unsafe fn bufferAllocator( &self, ) -> Retained<ProtocolObject<dyn MDLMeshBufferAllocator>>

Available on crate feature MDLMeshBuffer only.

Allocator used to create vertex and index buffers

pub unsafe fn vertexDescriptor(&self) -> Option<Retained<MDLVertexDescriptor>>

Available on crate feature MDLVertexDescriptor only.

Vertex descriptor set upon asset initialization

Will be nil if there was no descriptor set

pub unsafe fn addObject(&self, object: &MDLObject)

Available on crate feature MDLObject only.

Add a top level object to an asset.

If the object was already in the asset, this has no effect.

pub unsafe fn removeObject(&self, object: &MDLObject)

Available on crate feature MDLObject only.

Remove a top level object from an asset.

If the object not in the asset, this has no effect.

pub unsafe fn count(&self) -> NSUInteger

The number of top level objects

pub unsafe fn objectAtIndexedSubscript( &self, index: NSUInteger, ) -> Option<Retained<MDLObject>>

Available on crate feature MDLObject only.

return the indexed top level object

pub unsafe fn objectAtIndex(&self, index: NSUInteger) -> Retained<MDLObject>

Available on crate feature MDLObject only.

return the indexed top level object

pub unsafe fn masters( &self, ) -> Retained<ProtocolObject<dyn MDLObjectContainerComponent>>

👎Deprecated

Available on crate feature MDLTypes only.

pub unsafe fn setMasters( &self, masters: &ProtocolObject<dyn MDLObjectContainerComponent>, )

👎Deprecated

Available on crate feature MDLTypes only.

Setter for masters.

pub unsafe fn originals( &self, ) -> Retained<ProtocolObject<dyn MDLObjectContainerComponent>>

Available on crate feature MDLTypes only.

Original objects that can be instanced into the asset’s object hierarchy

See: MDLObjectContainerComponent

pub unsafe fn setOriginals( &self, originals: &ProtocolObject<dyn MDLObjectContainerComponent>, )

Available on crate feature MDLTypes only.

Setter for originals.

pub unsafe fn animations( &self, ) -> Retained<ProtocolObject<dyn MDLObjectContainerComponent>>

Available on crate feature MDLTypes only.

Animations that can be bound to MDLObjects (

See: MDLAnimationBindComponent)

See: MDLObjectContainerComponent

pub unsafe fn setAnimations( &self, animations: &ProtocolObject<dyn MDLObjectContainerComponent>, )

Available on crate feature MDLTypes only.

Setter for animations.

impl MDLAsset

Methods declared on superclass NSObject.

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

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

impl MDLAsset

MDLLightBaking.

Given a light probe density, method places light probes in the scene according to the passed in placement heuristic type. The higher the density, the greater the number of light probes placed in the scene.

Using the placement heuristic MDLProbePlacementUniformGrid places the light probes in the scene as a uniform grid. The placement heuristic MDLProbePlacementIrradianceDistribution places the light probes in areas of greatest irradiance change.

pub unsafe fn placeLightProbesWithDensity_heuristic_usingIrradianceDataSource( value: c_float, type: MDLProbePlacement, data_source: &ProtocolObject<dyn MDLLightProbeIrradianceDataSource>, ) -> Retained<NSArray<MDLLightProbe>>

Available on crate features MDLLight and MDLObject and MDLTypes only.

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 MDLAsset

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MDLAsset> for MDLAsset

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MDLAsset

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MDLAsset

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MDLAsset

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MDLAsset

const NAME: &'static str = "MDLAsset"

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

type Super = NSObject

The superclass of this class.

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

type Result = MDLAsset

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

impl Debug for MDLAsset

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

Formats the value using the given formatter.

impl Deref for MDLAsset

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MDLAsset

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 MDLAsset

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MDLAsset

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 NSFastEnumeration for MDLAsset

unsafe fn countByEnumeratingWithState_objects_count( &self, state: NonNull<NSFastEnumerationState>, buffer: NonNull<*mut AnyObject>, len: usize, ) -> usize

where Self: Sized + Message,

Safety

impl NSObjectProtocol for MDLAsset

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 MDLAsset

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 MDLAsset

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

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

impl DowncastTarget for MDLAsset

impl Eq for MDLAsset