Struct MDLVoxelArray

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

Available on crate features MDLObject and MDLVoxelArray only.

Voxel data represented on a three dimensional grid. Voxel data can include voxels considered to be on the surface of an object, and a series of shells on the outside and inside of the surface.

See also Apple’s documentation

Implementations

impl MDLVoxelArray

pub unsafe fn initWithAsset_divisions_patchRadius( this: Allocated<Self>, asset: &MDLAsset, divisions: c_int, patch_radius: c_float, ) -> Retained<Self>

Available on crate feature MDLAsset only.

Initialize a voxel grid from an MDLAsset. Attempts to create a closed volume model by applying “patches” of radius patchRadius to any holes found in the orginal mesh. Choose a patch radius that will be large enough to fill in the largest hole in the model.

pub unsafe fn initWithAsset_divisions_interiorShells_exteriorShells_patchRadius( this: Allocated<Self>, asset: &MDLAsset, divisions: c_int, interior_shells: c_int, exterior_shells: c_int, patch_radius: c_float, ) -> Retained<Self>

👎Deprecated

Available on crate feature MDLAsset only.

Initialize a voxel grid from an MDLAsset and dilate the resulting voxels by a number of interior and exterior shells. Routine will attempt to create a closed volume model by applying patches of a given radius to any holes it may find in the asset.

Parameter divisions: The number of divisions to divide the vertical extent of the model by.

Parameter interiorShells: The number of shells to compute inside the surface shell

Parameter exteriorShells: The number of shells to compute outside the surface shell

Parameter patchRadius: The radius of the largest model mending patch in world space units

pub unsafe fn initWithAsset_divisions_interiorNBWidth_exteriorNBWidth_patchRadius( this: Allocated<Self>, asset: &MDLAsset, divisions: c_int, interior_nb_width: c_float, exterior_nb_width: c_float, patch_radius: c_float, ) -> Retained<Self>

👎Deprecated

Available on crate feature MDLAsset only.

Initialize a voxel grid from an MDLAsset and dilate the resulting voxels by a spatial distance in the interior and exterior directions. Routine will attempt to create a closed volume model by applying “patches” of a given radius to any holes it may find in the asset.

Parameter divisions: The number of divisions to divide the vertical extent of the model by.

Parameter interiorNBWidth: The interior narrow band width in world space units

Parameter exteriorNBWidth: The exterior narrow band width in world space units

Parameter patchRadius: The radius of the largest model mending patch in world space units

pub unsafe fn count(&self) -> NSUInteger

The number of voxels in the grid

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

Returns an NSData containing the indices of all voxels in the voxel grid

pub unsafe fn setVoxelsForMesh_divisions_patchRadius( &self, mesh: &MDLMesh, divisions: c_int, patch_radius: c_float, )

Available on crate feature MDLMesh only.

Set voxels corresponding to a mesh. Routine will attempt to create a closed volume model by applying “patches” of a given radius to any holes it may find in the mesh.

pub unsafe fn setVoxelsForMesh_divisions_interiorShells_exteriorShells_patchRadius( &self, mesh: &MDLMesh, divisions: c_int, interior_shells: c_int, exterior_shells: c_int, patch_radius: c_float, )

👎Deprecated

Available on crate feature MDLMesh only.

Set voxels corresponding to a mesh Routine will attempt to create a closed volume model by applying “patches” of a given radius to any holes it may find in the mesh.

Parameter divisions: The number of divisions to divide the vertical extent of the model by.

Parameter interiorShells: The number of shells to compute inside the surface shell

Parameter exteriorShells: The number of shells to compute outside the surface shell

Parameter patchRadius: The radius of the largest model mending patch in world space units

pub unsafe fn setVoxelsForMesh_divisions_interiorNBWidth_exteriorNBWidth_patchRadius( &self, mesh: &MDLMesh, divisions: c_int, interior_nb_width: c_float, exterior_nb_width: c_float, patch_radius: c_float, )

👎Deprecated

Available on crate feature MDLMesh only.

Set voxels corresponding to a mesh Routine will attempt to create a closed volume model by applying “patches” of a given radius to any holes it may find in the mesh.

Parameter divisions: The number of divisions to divide the vertical extent of the model by.

Parameter interiorNBWidth: The interior narrow band width in world space units

Parameter exteriorNBWidth: The exterior narrow band width in world space units

Parameter patchRadius: The radius of the largest model mending patch in world space units

pub unsafe fn unionWithVoxels(&self, voxels: &MDLVoxelArray)

Union modifies the voxel grid to be the merger with the supplied voxel grid. It is assumed that the spatial voxel extent of one voxel in the supplied grid is the same as that of the voxel grid. Note that the shell level data will be cleared.

pub unsafe fn intersectWithVoxels(&self, voxels: &MDLVoxelArray)

Intersection modifies the voxel grid so that only voxels that are also in the supplied voxel grid are retained. It is assumed that the spatial voxel extent of one voxel in the supplied grid is the same as that of the voxel grid. Note that the shell level data will be cleared.

pub unsafe fn differenceWithVoxels(&self, voxels: &MDLVoxelArray)

Difference modifies the voxel grid so that voxels also in the supplied voxel grid are removed. It is assumed that the spatial voxel extent of one voxel in the supplied grid is the same as that of the voxel grid. Note that the shell level data will be cleared.

pub unsafe fn convertToSignedShellField(&self)

Converts volume grid into a signed shell field by surrounding the surface voxels, which have shell level values of zero, by an inner layer of voxels with shell level values of negative one and an outer layer of voxels with shell level values of positive one.

The volume model must be closed in order to generate a signed shell field.

pub unsafe fn isValidSignedShellField(&self) -> bool

Returns whether or not the volume grid is in a valid signed shell field form.

This property will be set to YES after calling generateSignedShellField. All other methods that modify the voxel grid will cause this property to be set to NO. Setting shellFieldInteriorThickness and shellFieldExteriorThickness will not affect the value of this property.

pub unsafe fn shellFieldInteriorThickness(&self) -> c_float

If voxel grid is in a valid signed shell field form, sets the interior thickness to the desired width, as measured from the model surface. If the voxel grid is not in a valid signed shell field form, the value of this property is zero.

pub unsafe fn setShellFieldInteriorThickness( &self, shell_field_interior_thickness: c_float, )

Setter for shellFieldInteriorThickness.

pub unsafe fn shellFieldExteriorThickness(&self) -> c_float

If voxel grid is in a valid signed shell field form, sets the exterior thickness to the desired width, as measured from the model surface. If the voxel grid is not in a valid signed shell field form, the value of this property is zero.

pub unsafe fn setShellFieldExteriorThickness( &self, shell_field_exterior_thickness: c_float, )

Setter for shellFieldExteriorThickness.

pub unsafe fn coarseMesh(&self) -> Option<Retained<MDLMesh>>

Available on crate feature MDLMesh only.

Creates a coarse mesh from the voxel grid

pub unsafe fn coarseMeshUsingAllocator( &self, allocator: Option<&ProtocolObject<dyn MDLMeshBufferAllocator>>, ) -> Option<Retained<MDLMesh>>

Available on crate features MDLMesh and MDLMeshBuffer only.

pub unsafe fn meshUsingAllocator( &self, allocator: Option<&ProtocolObject<dyn MDLMeshBufferAllocator>>, ) -> Option<Retained<MDLMesh>>

Available on crate features MDLMesh and MDLMeshBuffer only.

Creates a smooth mesh from the voxel grid

impl MDLVoxelArray

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = MDLObject>

pub unsafe fn components( &self, ) -> Retained<NSArray<ProtocolObject<dyn MDLComponent>>>

Available on crate feature MDLTypes only.

Allows applications to introspect the components on the objects.

pub unsafe fn setComponent_forProtocol( &self, component: &ProtocolObject<dyn MDLComponent>, protocol: &AnyProtocol, )

Available on crate feature MDLTypes only.

Extensible component support that allows user of ModelIO to customize MDLObjects to fit their format and workflow.

pub unsafe fn componentConformingToProtocol( &self, protocol: &AnyProtocol, ) -> Option<Retained<ProtocolObject<dyn MDLComponent>>>

Available on crate feature MDLTypes only.

Extensible component support that allows user of ModelIO to customize MDLObjects to fit their format and workflow.

pub unsafe fn objectForKeyedSubscript( &self, key: &AnyProtocol, ) -> Option<Retained<ProtocolObject<dyn MDLComponent>>>

Available on crate feature MDLTypes only.

Allows shorthand [key] syntax for componentConformingToProtocol:.

Parameter key: The protocol that the component conforms to.

See: componentConformingToProtocol:

pub unsafe fn setObject_forKeyedSubscript( &self, obj: Option<&ProtocolObject<dyn MDLComponent>>, key: &AnyProtocol, )

Available on crate feature MDLTypes only.

Allows shorthand [key] syntax for setComponent:forProtocol:.

Parameter key: The protocol that the component conforms to.

See: setComponent:forProtocol:

pub unsafe fn parent(&self) -> Option<Retained<MDLObject>>

Parent object. Nil if no parent.

Set to nil when you remove this from an object container inside the parent object.

pub unsafe fn setParent(&self, parent: Option<&MDLObject>)

This is a weak property. Setter for parent.

pub unsafe fn instance(&self) -> Option<Retained<MDLObject>>

Instance object

nil, unless this object refers to original data to be instanced. The original data object can be any MDLObject that does not have a parent. If an MDLAsset has been created from a data file, any original objects parsed from that file will be found in the originals property. A typical use of a original and instance might be to have one original chair MDLObject, and instance six chairs around a table. The transform of each chair would be found on the parent MDLObject, but the various items making up the chair would be found in the original object.

pub unsafe fn setInstance(&self, instance: Option<&MDLObject>)

Setter for instance.

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

a string representing a path to the object

a path is of the form /path/to/object where the path is formed by concatenating the names of the objects up the parent chain. Requesting a path will force any unnamed objects to became uniquely named. Any characters outside of [A-Z][a-z][0-9][:-_.] will be forced to underscore.

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

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

pub unsafe fn enumerateChildObjectsOfClass_root_usingBlock_stopPointer( &self, object_class: &AnyClass, root: &MDLObject, block: &DynBlock<dyn Fn(NonNull<MDLObject>, NonNull<Bool>)>, stop_pointer: NonNull<Bool>, )

Available on crate feature block2 only.

pub unsafe fn transform( &self, ) -> Option<Retained<ProtocolObject<dyn MDLTransformComponent>>>

Available on crate features MDLTransform and MDLTypes only.

Short hand property for the MDLTransformComponent.

The default value is nil

See: MDLTransformComponent

pub unsafe fn setTransform( &self, transform: Option<&ProtocolObject<dyn MDLTransformComponent>>, )

Available on crate features MDLTransform and MDLTypes only.

Setter for transform.

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

Available on crate feature MDLTypes only.

Short hand property for the MDLObjectContainerComponent.

The default value is an empty MDLObjectContainer

See: MDLObjectContainerComponent

pub unsafe fn setChildren( &self, children: &ProtocolObject<dyn MDLObjectContainerComponent>, )

Available on crate feature MDLTypes only.

Setter for children.

pub unsafe fn hidden(&self) -> bool

Visibility of the node

default is NO

pub unsafe fn setHidden(&self, hidden: bool)

Setter for hidden.

pub unsafe fn addChild(&self, child: &MDLObject)

Short hand for adding a child to the current container component and setting the parent to this object.

It will create a default container if none exists. If children are explicitly disallowed for an object, then add a container component that throws on addition.

See: MDLObjectContainer

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 MDLVoxelArray

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MDLObject> for MDLVoxelArray

fn as_ref(&self) -> &MDLObject

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

impl AsRef<MDLVoxelArray> for MDLVoxelArray

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MDLVoxelArray

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MDLVoxelArray

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MDLObject> for MDLVoxelArray

fn borrow(&self) -> &MDLObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MDLVoxelArray

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MDLVoxelArray

const NAME: &'static str = "MDLVoxelArray"

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

type Super = MDLObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for MDLVoxelArray

type Target = MDLObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MDLVoxelArray

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 MDLNamed for MDLVoxelArray

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

where Self: Sized + Message,

Available on crate feature MDLTypes only.

unsafe fn setName(&self, name: &NSString)

where Self: Sized + Message,

Available on crate feature MDLTypes only.

Setter for name.

impl Message for MDLVoxelArray

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for MDLVoxelArray

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 MDLVoxelArray

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 MDLVoxelArray

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

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

impl DowncastTarget for MDLVoxelArray

impl Eq for MDLVoxelArray