objc2-sprite-kit 0.3.2

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
#[cfg(feature = "objc2-app-kit")]
#[cfg(target_os = "macos")]
use objc2_app_kit::*;
#[cfg(feature = "objc2-avf-audio")]
use objc2_avf_audio::*;
#[cfg(feature = "objc2-core-foundation")]
use objc2_core_foundation::*;
use objc2_foundation::*;

use crate::*;

/// [Apple's documentation](https://developer.apple.com/documentation/spritekit/skscenescalemode?language=objc)
// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct SKSceneScaleMode(pub NSInteger);
impl SKSceneScaleMode {
    #[doc(alias = "SKSceneScaleModeFill")]
    pub const Fill: Self = Self(0);
    #[doc(alias = "SKSceneScaleModeAspectFill")]
    pub const AspectFill: Self = Self(1);
    #[doc(alias = "SKSceneScaleModeAspectFit")]
    pub const AspectFit: Self = Self(2);
    #[doc(alias = "SKSceneScaleModeResizeFill")]
    pub const ResizeFill: Self = Self(3);
}

unsafe impl Encode for SKSceneScaleMode {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

unsafe impl RefEncode for SKSceneScaleMode {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

extern_protocol!(
    /// [Apple's documentation](https://developer.apple.com/documentation/spritekit/skscenedelegate?language=objc)
    pub unsafe trait SKSceneDelegate: NSObjectProtocol {
        #[cfg(all(
            feature = "SKEffectNode",
            feature = "SKNode",
            feature = "objc2-app-kit"
        ))]
        #[cfg(target_os = "macos")]
        #[optional]
        #[unsafe(method(update:forScene:))]
        #[unsafe(method_family = none)]
        unsafe fn update_forScene(&self, current_time: NSTimeInterval, scene: &SKScene);

        #[cfg(all(
            feature = "SKEffectNode",
            feature = "SKNode",
            feature = "objc2-app-kit"
        ))]
        #[cfg(target_os = "macos")]
        #[optional]
        #[unsafe(method(didEvaluateActionsForScene:))]
        #[unsafe(method_family = none)]
        unsafe fn didEvaluateActionsForScene(&self, scene: &SKScene);

        #[cfg(all(
            feature = "SKEffectNode",
            feature = "SKNode",
            feature = "objc2-app-kit"
        ))]
        #[cfg(target_os = "macos")]
        #[optional]
        #[unsafe(method(didSimulatePhysicsForScene:))]
        #[unsafe(method_family = none)]
        unsafe fn didSimulatePhysicsForScene(&self, scene: &SKScene);

        #[cfg(all(
            feature = "SKEffectNode",
            feature = "SKNode",
            feature = "objc2-app-kit"
        ))]
        #[cfg(target_os = "macos")]
        #[optional]
        #[unsafe(method(didApplyConstraintsForScene:))]
        #[unsafe(method_family = none)]
        unsafe fn didApplyConstraintsForScene(&self, scene: &SKScene);

        #[cfg(all(
            feature = "SKEffectNode",
            feature = "SKNode",
            feature = "objc2-app-kit"
        ))]
        #[cfg(target_os = "macos")]
        #[optional]
        #[unsafe(method(didFinishUpdateForScene:))]
        #[unsafe(method_family = none)]
        unsafe fn didFinishUpdateForScene(&self, scene: &SKScene);
    }
);

extern_class!(
    /// A scene is the root node of your content. It is used to display SpriteKit content on an SKView.
    ///
    ///
    /// See: SKView
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/spritekit/skscene?language=objc)
    #[unsafe(super(SKEffectNode, SKNode, NSResponder, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(all(
        feature = "SKEffectNode",
        feature = "SKNode",
        feature = "objc2-app-kit"
    ))]
    #[cfg(target_os = "macos")]
    pub struct SKScene;
);

#[cfg(all(
    feature = "SKEffectNode",
    feature = "SKNode",
    feature = "objc2-app-kit"
))]
#[cfg(target_os = "macos")]
extern_conformance!(
    unsafe impl NSCoding for SKScene {}
);

#[cfg(all(
    feature = "SKEffectNode",
    feature = "SKNode",
    feature = "objc2-app-kit"
))]
#[cfg(target_os = "macos")]
extern_conformance!(
    unsafe impl NSCopying for SKScene {}
);

#[cfg(all(
    feature = "SKEffectNode",
    feature = "SKNode",
    feature = "objc2-app-kit"
))]
#[cfg(target_os = "macos")]
unsafe impl CopyingHelper for SKScene {
    type Result = Self;
}

#[cfg(all(
    feature = "SKEffectNode",
    feature = "SKNode",
    feature = "objc2-app-kit"
))]
#[cfg(target_os = "macos")]
extern_conformance!(
    unsafe impl NSObjectProtocol for SKScene {}
);

#[cfg(all(
    feature = "SKEffectNode",
    feature = "SKNode",
    feature = "objc2-app-kit"
))]
#[cfg(target_os = "macos")]
extern_conformance!(
    unsafe impl NSSecureCoding for SKScene {}
);

#[cfg(all(
    feature = "SKEffectNode",
    feature = "SKNode",
    feature = "SKWarpGeometry",
    feature = "objc2-app-kit"
))]
#[cfg(target_os = "macos")]
extern_conformance!(
    unsafe impl SKWarpable for SKScene {}
);

#[cfg(all(
    feature = "SKEffectNode",
    feature = "SKNode",
    feature = "objc2-app-kit"
))]
#[cfg(target_os = "macos")]
impl SKScene {
    extern_methods!(
        #[cfg(feature = "objc2-core-foundation")]
        /// A scene is infinitely large, but it has a viewport that is the frame through which you present the content of the scene.
        /// The passed in size defines the size of this viewport that you use to present the scene.
        ///
        ///
        /// Parameter `size`: a size in points that signifies the viewport into the scene that defines your framing of the scene.
        #[unsafe(method(initWithSize:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithSize(this: Allocated<Self>, size: CGSize) -> Retained<Self>;

        #[cfg(feature = "objc2-core-foundation")]
        #[unsafe(method(sceneWithSize:))]
        #[unsafe(method_family = none)]
        pub unsafe fn sceneWithSize(size: CGSize, mtm: MainThreadMarker) -> Retained<Self>;

        #[unsafe(method(sceneDidLoad))]
        #[unsafe(method_family = none)]
        pub unsafe fn sceneDidLoad(&self);

        #[cfg(feature = "objc2-core-foundation")]
        #[unsafe(method(size))]
        #[unsafe(method_family = none)]
        pub unsafe fn size(&self) -> CGSize;

        #[cfg(feature = "objc2-core-foundation")]
        /// Setter for [`size`][Self::size].
        #[unsafe(method(setSize:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setSize(&self, size: CGSize);

        /// Used to determine how to scale the scene to match the SKView it is being displayed in.
        #[unsafe(method(scaleMode))]
        #[unsafe(method_family = none)]
        pub unsafe fn scaleMode(&self) -> SKSceneScaleMode;

        /// Setter for [`scaleMode`][Self::scaleMode].
        #[unsafe(method(setScaleMode:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setScaleMode(&self, scale_mode: SKSceneScaleMode);

        #[cfg(feature = "SKCameraNode")]
        /// The camera that is used to obtain the view scale and translation based on where the camera is in relation to the scene.
        #[unsafe(method(camera))]
        #[unsafe(method_family = none)]
        pub unsafe fn camera(&self) -> Option<Retained<SKCameraNode>>;

        #[cfg(feature = "SKCameraNode")]
        /// Setter for [`camera`][Self::camera].
        ///
        /// This is a [weak property][objc2::topics::weak_property].
        #[unsafe(method(setCamera:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setCamera(&self, camera: Option<&SKCameraNode>);

        /// The node that is currently the listener for positional audio coming from SKAudioNodes
        ///
        /// See: SKAudioNode
        #[unsafe(method(listener))]
        #[unsafe(method_family = none)]
        pub unsafe fn listener(&self) -> Option<Retained<SKNode>>;

        /// Setter for [`listener`][Self::listener].
        ///
        /// This is a [weak property][objc2::topics::weak_property].
        #[unsafe(method(setListener:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setListener(&self, listener: Option<&SKNode>);

        #[cfg(feature = "objc2-avf-audio")]
        #[unsafe(method(audioEngine))]
        #[unsafe(method_family = none)]
        pub unsafe fn audioEngine(&self) -> Retained<AVAudioEngine>;

        /// Background color, defaults to gray
        #[unsafe(method(backgroundColor))]
        #[unsafe(method_family = none)]
        pub unsafe fn backgroundColor(&self) -> Retained<NSColor>;

        /// Setter for [`backgroundColor`][Self::backgroundColor].
        #[unsafe(method(setBackgroundColor:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setBackgroundColor(&self, background_color: &NSColor);

        #[unsafe(method(delegate))]
        #[unsafe(method_family = none)]
        pub unsafe fn delegate(&self) -> Option<Retained<ProtocolObject<dyn SKSceneDelegate>>>;

        /// Setter for [`delegate`][Self::delegate].
        ///
        /// This is a [weak property][objc2::topics::weak_property].
        #[unsafe(method(setDelegate:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setDelegate(&self, delegate: Option<&ProtocolObject<dyn SKSceneDelegate>>);

        #[cfg(feature = "objc2-core-foundation")]
        /// Used to choose the origin of the scene's coordinate system
        #[unsafe(method(anchorPoint))]
        #[unsafe(method_family = none)]
        pub unsafe fn anchorPoint(&self) -> CGPoint;

        #[cfg(feature = "objc2-core-foundation")]
        /// Setter for [`anchorPoint`][Self::anchorPoint].
        #[unsafe(method(setAnchorPoint:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setAnchorPoint(&self, anchor_point: CGPoint);

        #[cfg(feature = "SKPhysicsWorld")]
        /// Physics simulation functionality
        #[unsafe(method(physicsWorld))]
        #[unsafe(method_family = none)]
        pub unsafe fn physicsWorld(&self) -> Retained<SKPhysicsWorld>;

        #[cfg(feature = "SKView")]
        /// The SKView this scene is currently presented in, or nil if it is not being presented.
        #[unsafe(method(view))]
        #[unsafe(method_family = none)]
        pub unsafe fn view(&self) -> Option<Retained<SKView>>;

        #[cfg(feature = "objc2-core-foundation")]
        #[unsafe(method(convertPointFromView:))]
        #[unsafe(method_family = none)]
        pub unsafe fn convertPointFromView(&self, point: CGPoint) -> CGPoint;

        #[cfg(feature = "objc2-core-foundation")]
        #[unsafe(method(convertPointToView:))]
        #[unsafe(method_family = none)]
        pub unsafe fn convertPointToView(&self, point: CGPoint) -> CGPoint;

        /// Override this to perform per-frame game logic. Called exactly once per frame before any actions are evaluated and any physics are simulated.
        ///
        ///
        /// Parameter `currentTime`: the current time in the app. This must be monotonically increasing.
        #[unsafe(method(update:))]
        #[unsafe(method_family = none)]
        pub unsafe fn update(&self, current_time: NSTimeInterval);

        /// Override this to perform game logic. Called exactly once per frame after any actions have been evaluated but before any physics are simulated. Any additional actions applied is not evaluated until the next update.
        #[unsafe(method(didEvaluateActions))]
        #[unsafe(method_family = none)]
        pub unsafe fn didEvaluateActions(&self);

        /// Override this to perform game logic. Called exactly once per frame after any actions have been evaluated and any physics have been simulated. Any additional actions applied is not evaluated until the next update. Any changes to physics bodies is not simulated until the next update.
        #[unsafe(method(didSimulatePhysics))]
        #[unsafe(method_family = none)]
        pub unsafe fn didSimulatePhysics(&self);

        /// Override this to perform game logic. Called exactly once per frame after any enabled constraints have been applied. Any additional actions applied is not evaluated until the next update. Any changes to physics bodies is not simulated until the next update. Any changes to constraints will not be applied until the next update.
        #[unsafe(method(didApplyConstraints))]
        #[unsafe(method_family = none)]
        pub unsafe fn didApplyConstraints(&self);

        /// Override this to perform game logic. Called after all update logic has been completed. Any additional actions applied are not evaluated until the next update. Any changes to physics bodies are not simulated until the next update. Any changes to constraints will not be applied until the next update.
        ///
        /// No futher update logic will be applied to the scene after this call. Any values set on nodes here will be used when the scene is rendered for the current frame.
        #[unsafe(method(didFinishUpdate))]
        #[unsafe(method_family = none)]
        pub unsafe fn didFinishUpdate(&self);

        #[cfg(feature = "SKView")]
        #[unsafe(method(didMoveToView:))]
        #[unsafe(method_family = none)]
        pub unsafe fn didMoveToView(&self, view: &SKView);

        #[cfg(feature = "SKView")]
        #[unsafe(method(willMoveFromView:))]
        #[unsafe(method_family = none)]
        pub unsafe fn willMoveFromView(&self, view: &SKView);

        #[cfg(feature = "objc2-core-foundation")]
        #[unsafe(method(didChangeSize:))]
        #[unsafe(method_family = none)]
        pub unsafe fn didChangeSize(&self, old_size: CGSize);
    );
}

/// Methods declared on superclass `SKNode`.
#[cfg(all(
    feature = "SKEffectNode",
    feature = "SKNode",
    feature = "objc2-app-kit"
))]
#[cfg(target_os = "macos")]
impl SKScene {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        /// Support coding and decoding via NSKeyedArchiver.
        ///
        /// # Safety
        ///
        /// `a_decoder` possibly has further requirements.
        #[unsafe(method(initWithCoder:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithCoder(
            this: Allocated<Self>,
            a_decoder: &NSCoder,
        ) -> Option<Retained<Self>>;

        #[unsafe(method(node))]
        #[unsafe(method_family = none)]
        pub unsafe fn node(mtm: MainThreadMarker) -> Retained<Self>;

        #[unsafe(method(nodeWithFileNamed:))]
        #[unsafe(method_family = none)]
        pub unsafe fn nodeWithFileNamed(
            filename: &NSString,
            mtm: MainThreadMarker,
        ) -> Option<Retained<Self>>;

        /// # Safety
        ///
        /// `classes` generic probably has further requirements.
        #[unsafe(method(nodeWithFileNamed:securelyWithClasses:andError:_))]
        #[unsafe(method_family = none)]
        pub unsafe fn nodeWithFileNamed_securelyWithClasses_andError(
            filename: &NSString,
            classes: &NSSet<AnyClass>,
            mtm: MainThreadMarker,
        ) -> Result<Retained<Self>, Retained<NSError>>;
    );
}

/// Methods declared on superclass `NSObject`.
#[cfg(all(
    feature = "SKEffectNode",
    feature = "SKNode",
    feature = "objc2-app-kit"
))]
#[cfg(target_os = "macos")]
impl SKScene {
    extern_methods!(
        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>;
    );
}