Struct SCNView

Source

pub struct SCNView { /* private fields */ }

Available on crate feature SCNView and crate feature objc2-app-kit and macOS only.

Expand description

A SCNView is a subclass of NSView that can display a SCNScene

Implementations§

Source §

impl SCNView

Source

pub unsafe fn initWithFrame_options( this: Allocated<Self>, frame: NSRect, options: Option<&NSDictionary<NSString, AnyObject>>, ) -> Retained<Self>

Specifies the background color of the receiver. Defaults to opaque white.

Source

pub unsafe fn setBackgroundColor(&self, background_color: &NSColor)

Setter for backgroundColor.

This is copied when set.

Source

pub unsafe fn allowsCameraControl(&self) -> bool

A Boolean value that determines whether the user can manipulate the point of view used to render the scene.

When set to YES, the user can manipulate the current point of view with the mouse or the trackpad. The scene graph and existing cameras won’t be modified by this action. The default value of this property is NO. Note that the primary purpose of this property is to aid in debugging your application. You may want to implement your own camera controller suitable for your application. The built-in camera controller let you:

drag the mouse to rotate the camera around the scene
drag+cmd to rotate the camera in local space
drag+shift to rotate using sticky axis
use the scroll wheel or alt+drag the mouse to translate the camera on its local X,Y plan
alt+scroll wheel to move the camera forward/backward
rotate gesture (trackpad only) to roll the camera (rotation around the Z axis)
pinch gesture (trackpad only) move the camera forward/backward
alt + pinch gesture (trackpad only) to zoom-in / zoom-out (change the field of view of the camera)

Source

pub unsafe fn setAllowsCameraControl(&self, allows_camera_control: bool)

Setter for allowsCameraControl.

Source

pub unsafe fn cameraControlConfiguration( &self, ) -> Retained<ProtocolObject<dyn SCNCameraControlConfiguration>>

An object describing the current configuration of the event handler which pilot the default camera controller.

This object will be used to configure the event handler when allowCameraControl is set to YES.

Source

pub unsafe fn defaultCameraController(&self) -> Retained<SCNCameraController>

Available on crate feature SCNCameraController only.

Returns the default SCNCameraController used to drive the current point of view when allowCameraController is set to YES.

Source

pub unsafe fn snapshot(&self) -> Retained<NSImage>

Draws the contents of the view and returns them as a new image object

This method is thread-safe and may be called at any time.

Source

pub unsafe fn play(&self, sender: Option<&AnyObject>)

This action method begins playing the scene at its current location.

Parameter sender: The object (such as a button or menu item) sending the message to play the scene.

This method does not do anything if the scene is already playing.

§Safety

sender should be of the correct type.

Source

pub unsafe fn pause(&self, sender: Option<&AnyObject>)

This action method pauses the scene playback.

Parameter sender: The object (such as a button or menu item) sending the message to pause the scene.

This method does not do anything if the scene is already paused.

§Safety

sender should be of the correct type.

Source

👎Deprecated: OpenGL API deprecated, please use Metal instead. (Define SCN_SILENCE_GL_DEPRECATION to silence these warnings)

Specifies the OpenGL context associated with the receiver.

This property returns nil and has no effect if the current API is Metal.

Source

pub unsafe fn setOpenGLContext(&self, open_gl_context: Option<&NSOpenGLContext>)

👎Deprecated: OpenGL API deprecated, please use Metal instead. (Define SCN_SILENCE_GL_DEPRECATION to silence these warnings)

Setter for openGLContext.

Source

pub unsafe fn antialiasingMode(&self) -> SCNAntialiasingMode

Available on crate feature SCNSceneRenderer only.

Defaults to SCNAntialiasingModeMultisampling4X on macOS and SCNAntialiasingModeNone on iOS.

Source

pub unsafe fn setAntialiasingMode(&self, antialiasing_mode: SCNAntialiasingMode)

Available on crate feature SCNSceneRenderer only.

Setter for antialiasingMode.

Source

pub unsafe fn pixelFormat(&self) -> Option<Retained<NSOpenGLPixelFormat>>

👎Deprecated: OpenGL API deprecated, please use Metal instead. (Define SCN_SILENCE_GL_DEPRECATION to silence these warnings)

Specifies the pixel format of the receiver.

This property returns nil and has no effect if the current API is Metal.

Source

pub unsafe fn setPixelFormat(&self, pixel_format: Option<&NSOpenGLPixelFormat>)

👎Deprecated: OpenGL API deprecated, please use Metal instead. (Define SCN_SILENCE_GL_DEPRECATION to silence these warnings)

Setter for pixelFormat.

Source §

impl SCNView

Methods declared on superclass NSView.

Source

pub unsafe fn initWithFrame( this: Allocated<Self>, frame_rect: NSRect, ) -> Retained<Self>

Source

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

§Safety

coder possibly has further requirements.

Source §

impl SCNView

Methods declared on superclass NSResponder.

Source

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

Source §

impl SCNView

Methods declared on superclass NSObject.

Source

pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>

Methods from Deref<Target = NSView>§

Source

pub unsafe fn superview(&self) -> Option<Retained<NSView>>

§Safety

This is not retained internally, you must ensure the object is still alive.

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub fn isHidden(&self) -> bool

Source

pub fn setHidden(&self, hidden: bool)

Setter for isHidden.

Source

pub fn isHiddenOrHasHiddenAncestor(&self) -> bool

Source

pub unsafe fn getRectsBeingDrawn_count( &self, rects: mut const CGRect, count: *mut isize, )

§Safety

rects must be a valid pointer or null.
count must be a valid pointer or null.

Source

pub unsafe fn sortSubviewsUsingFunction_context( &self, compare: unsafe extern "C-unwind" fn(NonNull<NSView>, NonNull<NSView>, mut c_void) -> NSComparisonResult, context: mut c_void, )

§Safety

compare must be implemented correctly.
context must be a valid pointer or null.

pub fn resizeSubviewsWithOldSize(&self, old_size: CGSize)

Source

Source

pub fn frame(&self) -> CGRect

Source

pub fn setFrame(&self, frame: CGRect)

Setter for frame.

Setter for bounds.

Setter for canDrawConcurrently.

Source

pub fn canDraw(&self) -> bool

👎Deprecated: If a view needs display, -drawRect: or -updateLayer will be called automatically when the view is able to draw. To check whether a view is in a window, call -window. To check whether a view is hidden, call -isHiddenOrHasHiddenAncestor.

Source

pub fn setNeedsDisplayInRect(&self, invalid_rect: CGRect)

Source

pub fn needsDisplay(&self) -> bool

Source

pub fn setAcceptsTouchEvents(&self, accepts_touch_events: bool)

👎Deprecated: Use allowedTouchTypes instead

Source

pub fn canDrawSubviewsIntoLayer(&self) -> bool

Source

pub fn setCanDrawSubviewsIntoLayer(&self, can_draw_subviews_into_layer: bool)

Setter for canDrawSubviewsIntoLayer.

Source

pub fn layoutSubtreeIfNeeded(&self)

Source

Setter for toolTip.

This is copied when set.

Source

pub unsafe fn addToolTipRect_owner_userData( &self, rect: CGRect, owner: &AnyObject, data: *mut c_void, ) -> isize

§Safety

owner should be of the correct type.
data must be a valid pointer or null.

Setter for preparedContentRect.

Source

pub fn allowsVibrancy(&self) -> bool

Source

pub fn viewDidChangeEffectiveAppearance(&self)

Override point for reacting to the effective appearance of the receiver changing. At this point effectiveAppearance property reflects the new appearance.

Source

pub unsafe fn nextKeyView(&self) -> Option<Retained<NSView>>

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub unsafe fn setNextKeyView(&self, next_key_view: Option<&NSView>)

Setter for nextKeyView.

Source

pub unsafe fn print(&self, sender: Option<&AnyObject>)

§Safety

sender should be of the correct type.

Source

pub unsafe fn knowsPageRange(&self, range: *mut NSRange) -> bool

§Safety

range must be a valid pointer.

§Safety

options generic should be of the correct type.

Setter for additionalSafeAreaInsets.

Source

pub fn safeAreaRect(&self) -> CGRect

Source

pub fn prefersCompactControlSizeMetrics(&self) -> bool

When this property is true, any NSControls in the view or its descendants will be sized with compact metrics compatible with macOS 15 and earlier. Defaults to false

Source

pub fn setPrefersCompactControlSizeMetrics( &self, prefers_compact_control_size_metrics: bool, )

Setter for prefersCompactControlSizeMetrics.

Source

👎Deprecated

Methods from Deref<Target = NSResponder>§

Source

pub unsafe fn nextResponder(&self) -> Option<Retained<NSResponder>>

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub unsafe fn setNextResponder(&self, next_responder: Option<&NSResponder>)

Setter for nextResponder.

Source

pub fn becomeFirstResponder(&self) -> bool

Source

pub fn resignFirstResponder(&self) -> bool

Source

pub fn flushBufferedKeyEvents(&self)

Source

pub unsafe fn showContextHelp(&self, sender: Option<&AnyObject>)

§Safety

sender should be of the correct type.

Source

pub unsafe fn supplementalTargetForAction_sender( &self, action: Sel, sender: Option<&AnyObject>, ) -> Option<Retained<AnyObject>>

§Safety

action must be a valid selector.
sender should be of the correct type.

Source

pub fn undoManager(&self) -> Option<Retained<NSUndoManager>>

Source

pub fn presentError(&self, error: &NSError) -> bool

Source

pub fn willPresentError(&self, error: &NSError) -> Retained<NSError>

Source

pub fn performMnemonic(&self, string: &NSString) -> bool

👎Deprecated: This has always returned NO and had no effect on macOS

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.

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

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