Struct ARSCNPlaneGeometry 

pub struct ARSCNPlaneGeometry { /* private fields */ }

Available on crate features ARSCNPlaneGeometry and objc2 and objc2-scene-kit only.

A SceneKit geometry representing a plane.

See also Apple’s documentation

Implementations

impl ARSCNPlaneGeometry

pub unsafe fn planeGeometryWithDevice( device: &ProtocolObject<dyn MTLDevice>, ) -> Option<Retained<Self>>

Available on crate feature objc2-metal only.

Creates a new plane geometry using a Metal device.

Parameter device: A Metal device.

Returns: A new plane geometry.

pub unsafe fn updateFromPlaneGeometry(&self, plane_geometry: &ARPlaneGeometry)

Available on crate feature ARPlaneGeometry only.

Updates the geometry with the vertices of a plane geometry.

Parameter planeGeometry: A plane geometry.

impl ARSCNPlaneGeometry

Methods declared on superclass SCNGeometry.

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

Creates and returns an empty geometry object.

An empty geometry may be used as the lowest level of detail of a geometry.

pub unsafe fn geometryWithSources_elements( sources: &NSArray<SCNGeometrySource>, elements: Option<&NSArray<SCNGeometryElement>>, ) -> Retained<Self>

Available on crate feature objc2-foundation only.

Creates and returns a new geometry built from geometry sources and geometry elements.

Parameter sources: An array of geometry sources. If several geometry sources have the same semantic, only the first one is taken into account.

Parameter elements: An array of geometry elements. The sort order in the array determines the mapping between materials and geometry elements.

A geometry is made of geometry sources (at least SCNGeometrySourceSemanticVertex) and at least one geometry element. Multiple sources for texture coordinates are accepted. In that case the mappingChannel is implicitly set based on the order of the texture sources, starting at index 0.

pub unsafe fn geometryWithSources_elements_sourceChannels( sources: &NSArray<SCNGeometrySource>, elements: Option<&NSArray<SCNGeometryElement>>, source_channels: Option<&NSArray<NSNumber>>, ) -> Retained<Self>

Available on crate feature objc2-foundation only.

Creates and returns a new geometry built from geometry sources and geometry elements, with per-source indexed geometry data.

Parameter sources: An array of geometry sources. If several geometry sources have the same semantic, only the first one is taken into account.

Parameter elements: An array of geometry elements. The sort order in the array determines the mapping between materials and geometry elements.

Parameter sourceChannels: An array of indices that describes, for each geometry source, which channel of the geometry elements to use.

Example: geometry made of 3 primitives (2 quads, 1 pentagon) using different indices to reference position and UV data (2 channels)

Positions         ┆   POS0           POS3           POS4    ┆             quad   quad   pentagon    quad   quad   pentagon    ┆   SCNGeometryElement *element = [SCNGeometryElement geometryElementWithData:…
0 │ (0.0, 0.0, 0.0)   ┆        ┌───────────┬───────────┐        ┆           ┌─────┐ ┌─────┐ ┌───────┐ ┌─────┐ ┌─────┐ ┌───────┐   ┆                                                               primitiveType:SCNGeometryPrimitiveTypePolygon
1 │ (0.0, 1.0, 0.0)   ┆        │UV0     UV3│UV0     UV3│        ┆     4 4 5 0 1 2 3 5 4 3 2 7 6 5 2 1 0 1 2 3 2 3 0 1 1 2 3 4 0   ┆                                                              primitiveCount:3
2 │ (1.0, 0.0, 0.0)   ┆        │           │           │        ┆     └───┘ └───────────────────────┘ └───────────────────────┘   ┆                                                         indicesChannelCount:2
3 │ (1.0, 1.0, 0.0)   ┆        │     A     │     B     │        ┆   polygons        channel 0                 channel 1           ┆                                                  interleavedIndicesChannels:…
4 │ (2.0, 0.0, 0.0)   ┆        │           │           │        ┆                  (positions)                  (UVs)             ┆                                                               bytesPerIndex:…];
5 │ (2.0, 1.0, 0.0)   ┆        │UV1     UV2│UV1     UV2│        ┆                                                                 ┆
6 │ (2.0, 2.0, 0.0)   ┆   POS1 ├───────────┴───────────┤ POS5   ┆                                                                 ┆   SCNGeometry *geometry = [SCNGeometry geometryWithSources:
@
[positionSource, texcoordsSource]
7 │ (0.0, 2.0, 0.0)   ┆        │UVO       UV4       UV3│        ┆                                                                 ┆                                                   elements:
@
[element]
┆        │         POS2          │        ┆                quad A          quad B          pentagon C       ┆                                             sourceChannels:
@
[0, 1]];
UVs               ┆        │                       │        ┆           ┌─────────────┐ ┌─────────────┐ ┌─────────────────┐   ┆
0 │ (0.0, 0.0)        ┆        │           C           │        ┆     4 4 5 0 0 1 1 2 2 3 3 5 2 4 3 3 0 2 1 7 1 6 2 5 3 2 4 1 0   ┆
1 │ (0.0, 1.0)        ┆        │                       │        ┆     └───┘└──────────────────────────────────────────────────┘   ┆
2 │ (1.0, 1.0)        ┆        │UV1                 UV2│        ┆   polygons               interleaved  channels                  ┆
3 │ (1.0, 0.0)        ┆        └───────────────────────┘        ┆                           (positions and UVs)                   ┆
4 │ (0.5, 0.0)        ┆   POS7                          POS6    ┆                                                                 ┆

Example: geometry made of 3 primitives (2 quads, 1 pentagon) using the same indices to reference position and UV data (1 channel)

Positions         ┆   POS0           POS3           POS4    ┆             quad A      quad B      pentagon C                  ┆   SCNGeometryElement *element = [SCNGeometryElement geometryElementWithData:…
0 │ (0.0, 4.0, 0.0)   ┆        ┌───────────┬───────────┐        ┆           ┌────────┐  ┌────────┐  ┌───────────┐                 ┆                                                               primitiveType:SCNGeometryPrimitiveTypePolygon
1 │ (0.0, 2.0, 0.0)   ┆        │UV0     UV3│UV3     UV4│        ┆     4 4 5 0  1  2  3  5  4  3  2  7  6  5  2  1                 ┆                                                              primitiveCount:3
2 │ (2.0, 2.0, 0.0)   ┆        │           │           │        ┆     └───┘ └───────────────────────────────────┘                 ┆                                                               bytesPerIndex:…];
3 │ (2.0, 4.0, 0.0)   ┆        │     A     │     B     │        ┆   polygons              channel 0                               ┆
4 │ (4.0, 4.0, 0.0)   ┆        │           │           │        ┆                    (positions and UVs)                          ┆   SCNGeometry *geometry = [SCNGeometry geometryWithSources:
@
[positionSource, texcoordsSource]
5 │ (4.0, 2.0, 0.0)   ┆        │UV1     UV2│UV2     UV5│        ┆                                                                 ┆                                                   elements:
@
[element]];
6 │ (4.0, 0.0, 0.0)   ┆   POS1 ├───────────┴───────────┤ POS5   ┆                                                                 ┆
7 │ (0.0, 0.0, 0.0)   ┆        │UV1       UV2       UV5│        ┆                                                                 ┆                                            === or equivalently ===
┆        │         POS2          │        ┆                                                                 ┆
UVs               ┆        │                       │        ┆                                                                 ┆   SCNGeometryElement *element = [SCNGeometryElement geometryElementWithData:…
0 │ (0.0, 0.0)        ┆        │           C           │        ┆                                                                 ┆                                                               primitiveType:SCNGeometryPrimitiveTypePolygon
1 │ (0.0, 0.5)        ┆        │                       │        ┆                                                                 ┆                                                              primitiveCount:3
2 │ (0.5, 0.5)        ┆        │UV7                 UV6│        ┆                                                                 ┆                                                         indicesChannelCount:1
3 │ (0.5, 0.0)        ┆        └───────────────────────┘        ┆                                                                 ┆                                                  interleavedIndicesChannels:…
4 │ (1.0, 0.0)        ┆   POS7                          POS6    ┆                                                                 ┆                                                               bytesPerIndex:…];
5 │ (1.0, 0.5)        ┆                                         ┆                                                                 ┆
6 │ (1.0, 1.0)        ┆                                         ┆                                                                 ┆   SCNGeometry *geometry = [SCNGeometry geometryWithSources:
@
[positionSource, texcoordsSource]
7 │ (0.0, 1.0)        ┆                                         ┆                                                                 ┆                                                   elements:
@
[element]
┆                                         ┆                                                                 ┆                                             sourceChannels:
@
[0, 0]];                                                                                                                                               ┆

impl ARSCNPlaneGeometry

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = SCNGeometry>

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

Determines the name of the receiver.

pub unsafe fn setName(&self, name: Option<&NSString>)

Setter for name.

This is copied when set.

pub unsafe fn removeMaterialAtIndex(&self, index: usize)

Remove the material at the specified index from the materials array.

Parameter index: The index of the material to remove from the ‘materials’ array.

pub unsafe fn geometrySources(&self) -> Retained<NSArray<SCNGeometrySource>>

The array of geometry sources of the receiver.

pub unsafe fn geometrySourcesForSemantic( &self, semantic: &NSString, ) -> Retained<NSArray<SCNGeometrySource>>

Returns the geometry sources for a given semantic.

Parameter semantic: The semantic of the geometry sources that should be retrieved.

Returns nil if no geometry source is found for the given semantic. May return more than one source, typically for multiple texture coordinate sources.

pub unsafe fn geometryElements(&self) -> Retained<NSArray<SCNGeometryElement>>

The array of geometry elements of the receiver.

pub unsafe fn geometryElementCount(&self) -> isize

Returns the number of geometry elements owned by the geometry.

pub unsafe fn geometryElementAtIndex( &self, element_index: isize, ) -> Retained<SCNGeometryElement>

Returns the geometry element at a given index.

Parameter elementIndex: The index of the geometry element.

pub unsafe fn geometrySourceChannels( &self, ) -> Option<Retained<NSArray<NSNumber>>>

An array of indices that describes, for each geometry source, which channel of the geometry elements to use.

pub unsafe fn tessellator(&self) -> Option<Retained<SCNGeometryTessellator>>

pub unsafe fn setTessellator( &self, tessellator: Option<&SCNGeometryTessellator>, )

Setter for tessellator.

pub unsafe fn subdivisionLevel(&self) -> usize

Specifies the subdivision level of the receiver. Defaults to 0.

A subdivision level of 0 means no subdivision. When the tessellator property of the receiver is not nil, the refinement is done on the GPU.

pub unsafe fn setSubdivisionLevel(&self, subdivision_level: usize)

Setter for subdivisionLevel.

pub unsafe fn wantsAdaptiveSubdivision(&self) -> bool

Specifies if the subdivision is adaptive or uniform. Defaults to YES.

Adaptive subdivision requires that the tessellator property of the receiver is not nil.

pub unsafe fn setWantsAdaptiveSubdivision( &self, wants_adaptive_subdivision: bool, )

Setter for wantsAdaptiveSubdivision.

pub unsafe fn edgeCreasesElement(&self) -> Option<Retained<SCNGeometryElement>>

Specifies the edges creases that control the subdivision. Defaults to nil.

The primitive type of this geometry element must be SCNGeometryPrimitiveTypeLine. See subdivisionLevel above to control the level of subdivision. See edgeCreasesSource below to specify sharpness of the creases.

pub unsafe fn setEdgeCreasesElement( &self, edge_creases_element: Option<&SCNGeometryElement>, )

Setter for edgeCreasesElement.

pub unsafe fn edgeCreasesSource(&self) -> Option<Retained<SCNGeometrySource>>

Specifies the crease value of the edges specified by edgeCreasesElement. Defaults to nil.

The semantic of this geometry source must be “SCNGeometrySourceSemanticEdgeCrease”. The creases values are floating values between 0 and 10, where 0 means smooth and 10 means infinitely sharp. See subdivisionLevel above to control the level of subdivision. See edgeCreasesElement above to specify edges for edge creases.

pub unsafe fn setEdgeCreasesSource( &self, edge_creases_source: Option<&SCNGeometrySource>, )

Setter for edgeCreasesSource.

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<ARSCNPlaneGeometry> for ARSCNPlaneGeometry

fn as_ref(&self) -> &Self

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

impl AsRef<AnyObject> for ARSCNPlaneGeometry

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for ARSCNPlaneGeometry

fn as_ref(&self) -> &NSObject

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

impl AsRef<SCNGeometry> for ARSCNPlaneGeometry

fn as_ref(&self) -> &SCNGeometry

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

impl Borrow<AnyObject> for ARSCNPlaneGeometry

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for ARSCNPlaneGeometry

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<SCNGeometry> for ARSCNPlaneGeometry

fn borrow(&self) -> &SCNGeometry

Immutably borrows from an owned value.

impl ClassType for ARSCNPlaneGeometry

const NAME: &'static str = "ARSCNPlaneGeometry"

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

type Super = SCNGeometry

The superclass of this class.

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

Available on crate feature objc2-foundation only.

type Result = ARSCNPlaneGeometry

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

impl Debug for ARSCNPlaneGeometry

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

Formats the value using the given formatter.

impl Deref for ARSCNPlaneGeometry

type Target = SCNGeometry

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for ARSCNPlaneGeometry

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 ARSCNPlaneGeometry

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for ARSCNPlaneGeometry

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

impl NSCopying for ARSCNPlaneGeometry

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 NSObjectProtocol for ARSCNPlaneGeometry

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 ARSCNPlaneGeometry

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for ARSCNPlaneGeometry

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 ARSCNPlaneGeometry

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

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

impl SCNAnimatable for ARSCNPlaneGeometry

unsafe fn addAnimation_forKey( &self, animation: &ProtocolObject<dyn SCNAnimationProtocol>, key: Option<&NSString>, )

where Self: Sized + Message,

Adds and runs an animation

unsafe fn addAnimationPlayer_forKey( &self, player: &SCNAnimationPlayer, key: Option<&NSString>, )

where Self: Sized + Message,

Add an animation player.

unsafe fn removeAllAnimations(&self)

where Self: Sized + Message,

Remove all animations.

unsafe fn removeAnimationForKey(&self, key: &NSString)

where Self: Sized + Message,

Remove the animation with the given identifier.

unsafe fn animationKeys(&self) -> Retained<NSArray<NSString>>

where Self: Sized + Message,

Returns an array containing the keys of all animations currently attached to the receiver.

unsafe fn animationPlayerForKey( &self, key: &NSString, ) -> Option<Retained<SCNAnimationPlayer>>

where Self: Sized + Message,

Returns the animation player with the given identifier

unsafe fn pauseAnimationForKey(&self, key: &NSString)

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer setPaused:] instead

Pause the animation with the given identifier.

unsafe fn resumeAnimationForKey(&self, key: &NSString)

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer setPaused:] instead

Resume the animation with the given identifier.

unsafe fn isAnimationForKeyPaused(&self, key: &NSString) -> bool

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer paused] instead

Returns whether the animation for the specified identifier is paused.

impl SCNShadable for ARSCNPlaneGeometry

unsafe fn program(&self) -> Option<Retained<SCNProgram>>

where Self: Sized + Message,

Specifies a custom program used to render the receiver.

unsafe fn setProgram(&self, program: Option<&SCNProgram>)

where Self: Sized + Message,

Setter for program.

unsafe fn shaderModifiers( &self, ) -> Option<Retained<NSDictionary<NSString, NSString>>>

where Self: Sized + Message,

Dictionary of shader modifiers snippets, targeting entry points. The valid keys are the entry points described in the “Shader Modifier Entry Point” constants. The values are the code snippets formatted as described below.

unsafe fn setShaderModifiers( &self, shader_modifiers: Option<&NSDictionary<NSString, NSString>>, )

where Self: Sized + Message,

Setter for shaderModifiers.

unsafe fn minimumLanguageVersion(&self) -> Option<Retained<NSNumber>>

where Self: Sized + Message,

The minimum language version required to interpret the shadable source code (wrapped MTLLanguageVersion). Defaults to nil.

unsafe fn setMinimumLanguageVersion( &self, minimum_language_version: Option<&NSNumber>, )

where Self: Sized + Message,

Setter for minimumLanguageVersion.

impl DowncastTarget for ARSCNPlaneGeometry

impl Eq for ARSCNPlaneGeometry

impl SCNBoundingVolume for ARSCNPlaneGeometry