Struct SCNGeometrySource 

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

Available on crate feature SCNGeometry only.

A geometry source contains geometry data for a specific semantic. The data format is described by properties.

See also Apple’s documentation

Implementations

impl SCNGeometrySource

pub unsafe fn geometrySourceWithData_semantic_vectorCount_floatComponents_componentsPerVector_bytesPerComponent_dataOffset_dataStride( data: &NSData, semantic: &SCNGeometrySourceSemantic, vector_count: NSInteger, float_components: bool, components_per_vector: NSInteger, bytes_per_component: NSInteger, offset: NSInteger, stride: NSInteger, ) -> Retained<Self>

Creates and returns a geometry source from the given data and parameters.

Parameter data: The geometry data.

Parameter semantic: The semantic of the geometry source.

Parameter vectorCount: The number of geometry source vectors.

Parameter floatComponents: A flag that indicates if vector components are floating point values.

Parameter componentsPerVector: The number of scalar components in a vector.

Parameter bytesPerComponent: The number of bytes that represent a vector component.

Parameter offset: The offset from the beginning of the data. In bytes.

Parameter stride: The number of bytes from a vector to the next one in the data.

pub unsafe fn geometrySourceWithVertices_count( vertices: NonNull<SCNVector3>, count: NSInteger, ) -> Retained<Self>

Available on crate features SceneKitTypes and objc2-core-foundation only.

Creates and returns a geometry source from vertices stored in a buffer of SCNVector3 values.

Parameter vertices: The buffer of vertices.

Parameter count: The number of vertices.

Input vertices are copied to an optimized data format. The actual format is described by the properties of the resulting instance.

pub unsafe fn geometrySourceWithNormals_count( normals: NonNull<SCNVector3>, count: NSInteger, ) -> Retained<Self>

Available on crate features SceneKitTypes and objc2-core-foundation only.

Creates and returns a geometry source from normals stored in a buffer of SCNVector3 values.

Parameter normals: The buffer of normals.

Parameter count: The number of normals.

Input normals are copied to an optimized data format. The actual format is described by the properties of the resulting instance.

pub unsafe fn geometrySourceWithTextureCoordinates_count( texcoord: NonNull<CGPoint>, count: NSInteger, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Creates and returns a geometry source from texture coordinates stored in a buffer of CGPoint values.

Parameter texcoord: The buffer of texture coordinates.

Parameter count: The number of texture coordinate points.

Input texture coordinates are copied to an optimized data format. The actual format is described by the properties of the resulting instance.

pub unsafe fn geometrySourceWithBuffer_vertexFormat_semantic_vertexCount_dataOffset_dataStride( buffer: &ProtocolObject<dyn MTLBuffer>, vertex_format: MTLVertexFormat, semantic: &SCNGeometrySourceSemantic, vertex_count: NSInteger, offset: NSInteger, stride: NSInteger, ) -> Retained<Self>

Available on crate feature objc2-metal and non-watchOS only.

Creates and returns a geometry source from the given data and parameters.

Parameter buffer: A Metal buffer.

Parameter vertexFormat: The vertex format.

Parameter semantic: The semantic of the geometry source.

Parameter vertexCount: The number of vertex.

Parameter offset: The offset from the beginning of the data. In bytes.

Parameter stride: The number of bytes from a vector to the next one in the data.

Attempting to modify the Metal buffer outside the SCNSceneRenderer delegate callbacks is undefined. The typical usage it to modify the MTLBuffer within the willRenderScene callback, using a compute kernel or a vertex function in the user own command buffer. So something like:

• (void)renderer:(id <SCNSceneRenderer

)aRenderer willRenderScene:(SCNScene *)scene atTime:(NSTimeInterval)time { // ask for a new command buffer id <MTLCommandBuffer myCommandBuffer = [aRenderer.commandQueue commandBuffer];

// get a compute command encoder id <MTLComputeCommandEncoder

myComputeCommandEncoder = [myCommandBuffer computeCommandEncoder];

// configure the compute command encoder’s pipeline state, buffer inputs etc… //…

// dispatch the [myComputeCommandEncoder dispatchThreadgroups:numberOfWorkingGroups threadsPerThreadgroup:numberOfThreads]; [myComputeCommandEncoder endEncoding];

[myCommandBuffer commit]; }

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

The data for the geometry source

pub unsafe fn semantic(&self) -> Retained<SCNGeometrySourceSemantic>

The semantic of the geometry source

pub unsafe fn vectorCount(&self) -> NSInteger

The number of vectors in the data.

pub unsafe fn floatComponents(&self) -> bool

A flag that indicates if vector components are floating point values.

pub unsafe fn componentsPerVector(&self) -> NSInteger

The number of scalar components in each vector.

pub unsafe fn bytesPerComponent(&self) -> NSInteger

The size of a vector component in bytes.

pub unsafe fn dataOffset(&self) -> NSInteger

The offset from the beginning of the data. In bytes.

pub unsafe fn dataStride(&self) -> NSInteger

The number of bytes from a vector to the next one in the data.

impl SCNGeometrySource

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 SCNGeometrySource

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SCNGeometrySource

fn as_ref(&self) -> &NSObject

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

impl AsRef<SCNGeometrySource> for SCNGeometrySource

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCNGeometrySource

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCNGeometrySource

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SCNGeometrySource

const NAME: &'static str = "SCNGeometrySource"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for SCNGeometrySource

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCNGeometrySource

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 SCNGeometrySource

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SCNGeometrySource

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSObjectProtocol for SCNGeometrySource

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 SCNGeometrySource

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SCNGeometrySource

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 SCNGeometrySource

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

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

impl DowncastTarget for SCNGeometrySource

impl Eq for SCNGeometrySource