feat(soba/misc): rename inject* to just function name

Author: nartc

libs/soba/misc/src/lib/animations.ts

@@ -1,5 +1,5 @@
 import { computed, effect, ElementRef, Injector, isSignal, signal, untracked } from '@angular/core';
-import { injectBeforeRender, resolveRef } from 'angular-three';
+import { beforeRender, resolveRef } from 'angular-three';
 import { assertInjector } from 'ngxtension/assert-injector';
 import * as THREE from 'three';
 
@@ -38,17 +38,17 @@ export type NgtsAnimation<TAnimation extends NgtsAnimationClip = NgtsAnimationCl
 /**
  * Use afterNextRender
  */
-export function injectAnimations<TAnimation extends NgtsAnimationClip>(
-	animations: () => NgtsAnimation<TAnimation> | undefined | null,
+export function animations<TAnimation extends NgtsAnimationClip>(
+	animationsFactory: () => NgtsAnimation<TAnimation> | undefined | null,
 	object:
 		| ElementRef<THREE.Object3D>
 		| THREE.Object3D
 		| (() => ElementRef<THREE.Object3D> | THREE.Object3D | undefined | null),
 	{ injector }: { injector?: Injector } = {},
 ): NgtsAnimationApi<TAnimation> {
-	return assertInjector(injectAnimations, injector, () => {
+	return assertInjector(animations, injector, () => {
 		const mixer = new THREE.AnimationMixer(null!);
-		injectBeforeRender(({ delta }) => {
+		beforeRender(({ delta }) => {
 			if (!mixer.getRoot()) return;
 			mixer.update(delta);
 		});
@@ -74,7 +74,7 @@ export function injectAnimations<TAnimation extends NgtsAnimationClip>(
 
 			Object.assign(mixer, { _root: obj });
 
-			const maybeAnimationClips = animations();
+			const maybeAnimationClips = animationsFactory();
 			if (!maybeAnimationClips) return;
 
 			const animationClips = Array.isArray(maybeAnimationClips)
@@ -117,10 +117,27 @@ export function injectAnimations<TAnimation extends NgtsAnimationClip>(
 			});
 		});
 
-		const result = { ready, clips, mixer, actions, names } as unknown as NgtsAnimationApi<TAnimation>;
+		const result = { clips, mixer, actions, names } as NgtsAnimationApi<TAnimation>;
 
 		Object.defineProperty(result, 'isReady', { get: ready });
 
 		return result;
 	});
 }
+
+/**
+ * @deprecated use animations instead. Will be removed in v5.0.0
+ * @since v4.0.0
+ */
+export function injectAnimations<TAnimation extends NgtsAnimationClip>(
+	animationsFactory: () => NgtsAnimation<TAnimation> | undefined | null,
+	object:
+		| ElementRef<THREE.Object3D>
+		| THREE.Object3D
+		| (() => ElementRef<THREE.Object3D> | THREE.Object3D | undefined | null),
+	{ injector }: { injector?: Injector } = {},
+): NgtsAnimationApi<TAnimation> {
+	return assertInjector(injectAnimations, injector, () => {
+		return animations(animationsFactory, object, { injector });
+	});
+}

libs/soba/misc/src/lib/depth-buffer.ts

@@ -1,14 +1,14 @@
 import { computed, Injector } from '@angular/core';
-import { injectBeforeRender, injectStore } from 'angular-three';
+import { beforeRender, injectStore } from 'angular-three';
 import { assertInjector } from 'ngxtension/assert-injector';
 import * as THREE from 'three';
-import { injectFBO } from './fbo';
+import { fbo } from './fbo';
 
-export function injectDepthBuffer(
+export function depthBuffer(
 	params: () => { size?: number; frames?: number } = () => ({}),
 	{ injector }: { injector?: Injector } = {},
 ) {
-	return assertInjector(injectDepthBuffer, injector, () => {
+	return assertInjector(depthBuffer, injector, () => {
 		const size = computed(() => params().size || 256);
 		const frames = computed(() => params().frames || Infinity);
 
@@ -24,10 +24,10 @@ export function injectDepthBuffer(
 			return { depthTexture };
 		});
 
-		const depthFBO = injectFBO(() => ({ width: w(), height: h(), settings: depthConfig() }));
+		const depthFBO = fbo(() => ({ width: w(), height: h(), settings: depthConfig() }));
 
 		let count = 0;
-		injectBeforeRender(({ gl, scene, camera }) => {
+		beforeRender(({ gl, scene, camera }) => {
 			if (frames() === Infinity || count < frames()) {
 				gl.setRenderTarget(depthFBO);
 				gl.render(scene, camera);
@@ -39,3 +39,16 @@ export function injectDepthBuffer(
 		return depthFBO.depthTexture;
 	});
 }
+
+/**
+ * @deprecated use depthBuffer instead. Will be removed in v5.0.0
+ * @since v4.0.0
+ */
+export function injectDepthBuffer(
+	params: () => { size?: number; frames?: number } = () => ({}),
+	{ injector }: { injector?: Injector } = {},
+) {
+	return assertInjector(injectDepthBuffer, injector, () => {
+		return depthBuffer(params, { injector });
+	});
+}

libs/soba/misc/src/lib/fbo.ts

@@ -42,8 +42,8 @@ export interface NgtsFBOParams {
 	settings?: FBOSettings;
 }
 
-export function injectFBO(params: () => NgtsFBOParams = () => ({}), { injector }: { injector?: Injector } = {}) {
-	return assertInjector(injectFBO, injector, () => {
+export function fbo(params: () => NgtsFBOParams = () => ({}), { injector }: { injector?: Injector } = {}) {
+	return assertInjector(fbo, injector, () => {
 		const store = injectStore();
 
 		const width = computed(() => {
@@ -99,6 +99,16 @@ export function injectFBO(params: () => NgtsFBOParams = () => ({}), { injector }
 	});
 }
 
+/**
+ * @deprecated use fbo instead. Will be removed in v5.0.0
+ * @since v4.0.0
+ */
+export function injectFBO(params: () => NgtsFBOParams = () => ({}), { injector }: { injector?: Injector } = {}) {
+	return assertInjector(injectFBO, injector, () => {
+		return fbo(params, { injector });
+	});
+}
+
 @Directive({ selector: 'ng-template[fbo]' })
 export class NgtsFBO {
 	fbo = input({} as { width: NgtsFBOParams['width']; height: NgtsFBOParams['height'] } & FBOSettings);
@@ -107,9 +117,9 @@ export class NgtsFBO {
 	private viewContainerRef = inject(ViewContainerRef);
 
 	constructor() {
-		let ref: EmbeddedViewRef<{ $implicit: ReturnType<typeof injectFBO> }>;
+		let ref: EmbeddedViewRef<{ $implicit: ReturnType<typeof fbo> }>;
 
-		const fboTarget = injectFBO(() => {
+		const fboTarget = fbo(() => {
 			const { width, height, ...settings } = this.fbo();
 			return { width, height, settings };
 		});
@@ -124,7 +134,7 @@ export class NgtsFBO {
 		});
 	}
 
-	static ngTemplateContextGuard(_: NgtsFBO, ctx: unknown): ctx is { $implicit: ReturnType<typeof injectFBO> } {
+	static ngTemplateContextGuard(_: NgtsFBO, ctx: unknown): ctx is { $implicit: ReturnType<typeof fbo> } {
 		return true;
 	}
 }