Package apple.phase

Class PHASEEngine

  • All Implemented Interfaces:
    NSObject
    public class PHASEEngine
extends NSObject
    [@interface] PHASEEngine PHASE engine instance. API-Since: 15.0

    • Constructor Detail

      • PHASEEngine

        protected PHASEEngine​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • activeGroupPreset

        @Nullable
public @Nullable PHASEGroupPreset activeGroupPreset()
        [@property] activeGroupPreset The active group mixer preset in the system Returns nil if there are no active group presets in the engine. Activate or Deactivate the preset via [PHASEGroupPreset activate] and [PHASEGroupPreset deactivate]

      • allocWithZone

        public static PHASEEngine allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • assetRegistry

        @NotNull
public @NotNull PHASEAssetRegistry assetRegistry()
        [@property] assetRegistry A registry for assets available to the engine

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • defaultMedium

        @NotNull
public @NotNull PHASEMedium defaultMedium()
        [@property] defaultMedium The default medium in the engine. The default value is PHASEMediumPresetAir.

      • defaultReverbPreset

        public long defaultReverbPreset()
        [@property] defaultReverbPreset The default reverb preset in the engine. The default value is PHASEReverbPresetNone.

      • description_static

        public static java.lang.String description_static()

      • duckers

        @NotNull
public @NotNull NSArray<? extends PHASEDucker> duckers()
        [@property] duckers An array of the ducker objects in the system Returns a dictionary of the ducker objects at the time it is retrieved.

      • groups

        @NotNull
public @NotNull NSDictionary<java.lang.String,​? extends PHASEGroup> groups()
        [@property] groups A dictionary of the groups in the system Returns a dictionary of the groups at the time it is retrieved.

      • hash_static

        public static long hash_static()

      • initWithUpdateMode

        public PHASEEngine initWithUpdateMode​(long updateMode)
        initWithUpdateMode: Initialize a new engine with an update mode.
        Parameters:
        updateMode - Defines how the engine will be updated.

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • outputSpatializationMode

        public long outputSpatializationMode()
        [@property] outputSpatializationMode When set to a value other than PHASESpatializationModeAutomatic, overrides the default output spatializer and uses the specified one instead.

      • pause

        public void pause()
        pause Pause the engine.

      • renderingState

        public long renderingState()
        [@property] renderingState The engine's current rendering state.

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • rootObject

        @NotNull
public @NotNull PHASEObject rootObject()
        [@property] rootObject The root object of the engine's scene graph. Attach objects to the engine's rootObject or one of its children to make them active within the engine's scene graph. This will ensure they take part in the simulation. [@note] The rootObject is created and owned by the engine. The rootObject may not be set as the child of another object. This will cause an error to be thrown. The rootObject's transform may not be changed. This will cause an error to be thrown. The rootObject may not be copied. This will cause an error to be thrown.

      • setDefaultMedium

        public void setDefaultMedium​(@NotNull
                             @NotNull PHASEMedium value)
        [@property] defaultMedium The default medium in the engine. The default value is PHASEMediumPresetAir.

      • setDefaultReverbPreset

        public void setDefaultReverbPreset​(long value)
        [@property] defaultReverbPreset The default reverb preset in the engine. The default value is PHASEReverbPresetNone.

      • setOutputSpatializationMode

        public void setOutputSpatializationMode​(long value)
        [@property] outputSpatializationMode When set to a value other than PHASESpatializationModeAutomatic, overrides the default output spatializer and uses the specified one instead.

      • setUnitsPerMeter

        public void setUnitsPerMeter​(double value)
        [@property] unitsPerMeter The number of units in a meter. The unitsPerMeter is used internally to scale metric values passed to the API. This allows clients to pass metric values in their own native spatial scale. [@note] Values are clamped to the range (0, inf]. Default value is 1.

      • setUnitsPerSecond

        public void setUnitsPerSecond​(double value)
        [@property] unitsPerSecond The number of units in a second. The unitsPerSecond is used internally to scale time/duration values passed to the API. This allows clients to pass time/duration values in their own native time scale. [@note] Values are clamped to the range (0, inf]. Default value is 1.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • soundEvents

        @NotNull
public @NotNull NSArray<? extends PHASESoundEvent> soundEvents()
        [@property] soundEvents An array of the active sound event objects in the system Returns a dictionary of the sound events at the time it is retrieved. This includes all sound events that are registered with the engine, including those that are preparing, playing, paused or stopping.

      • startAndReturnError

        public boolean startAndReturnError​(@Nullable
                                   @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        startAndReturnError: Start or resume the engine.
        Returns:
        YES for success.

      • stop

        public void stop()
        stop Stop the engine.

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • unitsPerMeter

        public double unitsPerMeter()
        [@property] unitsPerMeter The number of units in a meter. The unitsPerMeter is used internally to scale metric values passed to the API. This allows clients to pass metric values in their own native spatial scale. [@note] Values are clamped to the range (0, inf]. Default value is 1.

      • unitsPerSecond

        public double unitsPerSecond()
        [@property] unitsPerSecond The number of units in a second. The unitsPerSecond is used internally to scale time/duration values passed to the API. This allows clients to pass time/duration values in their own native time scale. [@note] Values are clamped to the range (0, inf]. Default value is 1.

      • update

        public void update()
        update: Manually update the engine instance on the calling thread. This will kick off all of the API commands called since the last call to update, update any systems and objects that need to be kept current, and call any registered handlers. [@note] This function has no effect if the engine's update mode is PHASEUpdateModeAutomatic.

      • version_static

        public static long version_static()

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.