rhodonite 0.4.2 → 0.5.2

package/dist/esm/foundation/core/Entity.d.ts

@@ -1,84 +1,84 @@
-import TransformComponent from '../components/TransformComponent';
-import SceneGraphComponent from '../components/SceneGraphComponent';
-import Component from './Component';
-import RnObject from './RnObject';
-import { ComponentTID, EntityUID } from '../../types/CommonTypes';
-import SkeletalComponent from '../components/SkeletalComponent';
-import MeshComponent from '../components/MeshComponent';
-import MeshRendererComponent from '../components/MeshRendererComponent';
-import CameraComponent from '../components/CameraComponent';
-import BlendShapeComponent from '../components/BlendShapeComponent';
-import PhysicsComponent from '../components/PhysicsComponent';
-import CameraControllerComponent from '../components/CameraControllerComponent';
-import LightComponent from '../components/LightComponent';
-/**
- * The Rhodonite Entity Class which are an entities that exists in space.
- * Entities can acquire various functions by having components on themselves.
- */
-export default class Entity extends RnObject {
-    private readonly __entity_uid;
-    static readonly invalidEntityUID = -1;
-    private __isAlive;
-    private static __instance;
-    private __components;
-    private __transformComponent?;
-    private __sceneGraphComponent?;
-    private __skeletalComponent?;
-    private __meshComponent?;
-    private __meshRendererComponent?;
-    private __cameraComponent?;
-    private __cameraControllerComponent?;
-    private __blendShapeComponent?;
-    private __physicsComponent?;
-    private __lightComponent?;
-    /**
-     * The constructor of the Entity class.
-     * When creating an Entity, use the createEntity method of the EntityRepository class
-     * instead of directly calling this constructor.
-     * @param entityUID The unique ID of the entity
-     * @param isAlive Whether this entity alive or not
-     * @param entityComponent The instance of EntityComponent (Dependency Injection)
-     */
-    constructor(entityUID: EntityUID, isAlive: Boolean);
-    /**
-     * Get Unique ID of the entity.
-     */
-    get entityUID(): number;
-    /**
-     * @private
-     * Sets a component to this entity.
-     * @param component The component to set.
-     */
-    _setComponent(component: Component): void;
-    /**
-     * Get the component of the specified type that the entity has
-     * @param componentType
-     */
-    getComponent(componentType: typeof Component): Component | null;
-    /**
-     * Gets the component corresponding to the ComponentTID.
-     * @param componentTID The ComponentTID to get the component.
-     */
-    getComponentByComponentTID(componentTID: ComponentTID): Component | null;
-    /**
-     * Get the TransformComponent of the entity.
-     * It's a shortcut method of getComponent(TransformComponent).
-     */
-    getTransform(): TransformComponent;
-    /**
-     * Get the SceneGraphComponent of the entity.
-     * It's a shortcut method of getComponent(SceneGraphComponent).
-     */
-    getSceneGraph(): SceneGraphComponent;
-    getSkeletal(): SkeletalComponent;
-    getMesh(): MeshComponent;
-    getMeshRenderer(): MeshRendererComponent;
-    getCamera(): CameraComponent;
-    getCameraController(): CameraControllerComponent;
-    getBlendShape(): BlendShapeComponent;
-    getPhysics(): PhysicsComponent;
-    getLight(): LightComponent;
-    get worldMatrixInner(): import("../math/MutableMatrix44").default | undefined;
-    get worldMatrix(): import("../math/MutableMatrix44").default | undefined;
-    getChildByName(name: string): Entity | undefined;
-}
+import TransformComponent from '../components/TransformComponent';
+import SceneGraphComponent from '../components/SceneGraphComponent';
+import Component from './Component';
+import RnObject from './RnObject';
+import { ComponentTID, EntityUID } from '../../types/CommonTypes';
+import SkeletalComponent from '../components/SkeletalComponent';
+import MeshComponent from '../components/MeshComponent';
+import MeshRendererComponent from '../components/MeshRendererComponent';
+import CameraComponent from '../components/CameraComponent';
+import BlendShapeComponent from '../components/BlendShapeComponent';
+import PhysicsComponent from '../components/PhysicsComponent';
+import CameraControllerComponent from '../components/CameraControllerComponent';
+import LightComponent from '../components/LightComponent';
+/**
+ * The Rhodonite Entity Class which are an entities that exists in space.
+ * Entities can acquire various functions by having components on themselves.
+ */
+export default class Entity extends RnObject {
+    private readonly __entity_uid;
+    static readonly invalidEntityUID = -1;
+    private __isAlive;
+    private static __instance;
+    private __components;
+    private __transformComponent?;
+    private __sceneGraphComponent?;
+    private __skeletalComponent?;
+    private __meshComponent?;
+    private __meshRendererComponent?;
+    private __cameraComponent?;
+    private __cameraControllerComponent?;
+    private __blendShapeComponent?;
+    private __physicsComponent?;
+    private __lightComponent?;
+    /**
+     * The constructor of the Entity class.
+     * When creating an Entity, use the createEntity method of the EntityRepository class
+     * instead of directly calling this constructor.
+     * @param entityUID The unique ID of the entity
+     * @param isAlive Whether this entity alive or not
+     * @param entityComponent The instance of EntityComponent (Dependency Injection)
+     */
+    constructor(entityUID: EntityUID, isAlive: Boolean);
+    /**
+     * Get Unique ID of the entity.
+     */
+    get entityUID(): number;
+    /**
+     * @private
+     * Sets a component to this entity.
+     * @param component The component to set.
+     */
+    _setComponent(component: Component): void;
+    /**
+     * Get the component of the specified type that the entity has
+     * @param componentType
+     */
+    getComponent(componentType: typeof Component): Component | null;
+    /**
+     * Gets the component corresponding to the ComponentTID.
+     * @param componentTID The ComponentTID to get the component.
+     */
+    getComponentByComponentTID(componentTID: ComponentTID): Component | null;
+    /**
+     * Get the TransformComponent of the entity.
+     * It's a shortcut method of getComponent(TransformComponent).
+     */
+    getTransform(): TransformComponent;
+    /**
+     * Get the SceneGraphComponent of the entity.
+     * It's a shortcut method of getComponent(SceneGraphComponent).
+     */
+    getSceneGraph(): SceneGraphComponent;
+    getSkeletal(): SkeletalComponent;
+    getMesh(): MeshComponent;
+    getMeshRenderer(): MeshRendererComponent;
+    getCamera(): CameraComponent;
+    getCameraController(): CameraControllerComponent;
+    getBlendShape(): BlendShapeComponent;
+    getPhysics(): PhysicsComponent;
+    getLight(): LightComponent;
+    get worldMatrixInner(): import("../math/MutableMatrix44").default | undefined;
+    get worldMatrix(): import("../math/MutableMatrix44").default | undefined;
+    getChildByName(name: string): Entity | undefined;
+}

package/dist/esm/foundation/core/EntityRepository.d.ts

@@ -1,62 +1,62 @@
-import Entity from './Entity';
-import Component from './Component';
-import { RnTags, EntityUID, ComponentTID } from '../../types/CommonTypes';
-/**
- * The class that generates and manages entities.
- */
-export default class EntityRepository {
-    private __entity_uid_count;
-    private __entities;
-    private static __instance;
-    private __componentRepository;
-    _components: Array<Map<ComponentTID, Component>>;
-    private constructor();
-    static getInstance(): EntityRepository;
-    /**
-     * Creates an entity which has the given types of the components
-     * @param componentClasses The class objects of the components.
-     */
-    createEntity(componentClasses: Array<typeof Component>): Entity;
-    /**
-     * Add components to the entity.
-     * @param componentClasses The class objects to set to the entity.
-     * @param entityUid The entityUID of the entity.
-     */
-    addComponentsToEntity(componentClasses: Array<typeof Component>, entityUid: EntityUID): Entity;
-    /**
-     * Remove components from the entity.
-     * @param componentClasses The class object of the components to remove.
-     * @param entityUid The entityUID of the entity.
-     */
-    removeComponentsFromEntity(componentClasses: Array<typeof Component>, entityUid: EntityUID): Entity;
-    /**
-     * Gets the entity corresponding to the entityUID.
-     * @param entityUid The entityUID of the entity.
-     */
-    getEntity(entityUid: EntityUID): Entity;
-    /**
-     * Gets the specified component from the entity.
-     * @param entityUid The entity to get the component from.
-     * @param componentType The class object of the component to get.
-     */
-    getComponentOfEntity(entityUid: EntityUID, componentType: typeof Component): Component | null;
-    /**
-     * Search entities by the given tags.
-     * @param tags The tags to search
-     */
-    searchByTags(tags: RnTags): Entity[];
-    /**
-     * Gets entity by the unique name.
-     * @param uniqueName The unique name of the entity.
-     */
-    getEntityByUniqueName(uniqueName: string): Entity | undefined;
-    /**
-     * @private
-     * Gets all entities.
-     */
-    _getEntities(): Entity[];
-    /**
-     * Gets the number of all entities.
-     */
-    getEntitiesNumber(): number;
-}
+import Entity from './Entity';
+import Component from './Component';
+import { RnTags, EntityUID, ComponentTID } from '../../types/CommonTypes';
+/**
+ * The class that generates and manages entities.
+ */
+export default class EntityRepository {
+    private __entity_uid_count;
+    private __entities;
+    private static __instance;
+    private __componentRepository;
+    _components: Array<Map<ComponentTID, Component>>;
+    private constructor();
+    static getInstance(): EntityRepository;
+    /**
+     * Creates an entity which has the given types of the components
+     * @param componentClasses The class objects of the components.
+     */
+    createEntity(componentClasses: Array<typeof Component>): Entity;
+    /**
+     * Add components to the entity.
+     * @param componentClasses The class objects to set to the entity.
+     * @param entityUid The entityUID of the entity.
+     */
+    addComponentsToEntity(componentClasses: Array<typeof Component>, entityUid: EntityUID): Entity;
+    /**
+     * Remove components from the entity.
+     * @param componentClasses The class object of the components to remove.
+     * @param entityUid The entityUID of the entity.
+     */
+    removeComponentsFromEntity(componentClasses: Array<typeof Component>, entityUid: EntityUID): Entity;
+    /**
+     * Gets the entity corresponding to the entityUID.
+     * @param entityUid The entityUID of the entity.
+     */
+    getEntity(entityUid: EntityUID): Entity;
+    /**
+     * Gets the specified component from the entity.
+     * @param entityUid The entity to get the component from.
+     * @param componentType The class object of the component to get.
+     */
+    getComponentOfEntity(entityUid: EntityUID, componentType: typeof Component): Component | null;
+    /**
+     * Search entities by the given tags.
+     * @param tags The tags to search
+     */
+    searchByTags(tags: RnTags): Entity[];
+    /**
+     * Gets entity by the unique name.
+     * @param uniqueName The unique name of the entity.
+     */
+    getEntityByUniqueName(uniqueName: string): Entity | undefined;
+    /**
+     * @private
+     * Gets all entities.
+     */
+    _getEntities(): Entity[];
+    /**
+     * Gets the number of all entities.
+     */
+    getEntitiesNumber(): number;
+}

package/dist/esm/foundation/core/GlobalDataRepository.d.ts

@@ -1,31 +1,32 @@
-import { ShaderSemanticsInfo, ShaderSemanticsEnum, getShaderPropertyFunc } from '../definitions/ShaderSemantics';
-import { Count, Index, CGAPIResourceHandle, IndexOf16Bytes } from '../../types/CommonTypes';
-import Accessor from '../memory/Accessor';
-import { ProcessApproachEnum } from '../..';
-declare type GlobalPropertyStruct = {
-    shaderSemanticsInfo: ShaderSemanticsInfo;
-    values: any[];
-    maxCount: Count;
-    accessor: Accessor;
-};
-/**
- * The class which manages global data.
- */
-export default class GlobalDataRepository {
-    private static __instance;
-    private __fields;
-    private constructor();
-    initialize(approach: ProcessApproachEnum): void;
-    static getInstance(): GlobalDataRepository;
-    registerProperty(semanticInfo: ShaderSemanticsInfo, maxCount: Count): void;
-    takeOne(shaderSemantic: ShaderSemanticsEnum, arrayIndex?: Index): any;
-    setValue(shaderSemantic: ShaderSemanticsEnum, countIndex: Index, value: any, arrayIndex?: Index): void;
-    getValue(shaderSemantic: ShaderSemanticsEnum, countIndex: Index, arrayIndex?: Index): any;
-    getGlobalPropertyStruct(propertyIndex: Index): GlobalPropertyStruct | undefined;
-    setUniformLocations(shaderProgramUid: CGAPIResourceHandle, isUniformOnlyMode: boolean): void;
-    setUniformValues(shaderProgram: WebGLProgram): void;
-    getLocationOffsetOfProperty(propertyIndex: Index): IndexOf16Bytes;
-    getCurrentDataNumberOfTheProperty(propertyIndex: Index): number;
-    addPropertiesStr(vertexPropertiesStr: string, pixelPropertiesStr: string, propertySetter: getShaderPropertyFunc, isWebGL2: boolean): string[];
-}
-export {};
+import { ShaderSemanticsInfo, ShaderSemanticsEnum, getShaderPropertyFunc } from '../definitions/ShaderSemantics';
+import { Count, Index, CGAPIResourceHandle, IndexOf16Bytes } from '../../types/CommonTypes';
+import Accessor from '../memory/Accessor';
+import { ProcessApproachEnum } from '../../foundation/definitions/ProcessApproach';
+declare type GlobalPropertyStruct = {
+    shaderSemanticsInfo: ShaderSemanticsInfo;
+    values: any[];
+    maxCount: Count;
+    accessor: Accessor;
+};
+/**
+ * The class which manages global data.
+ */
+export default class GlobalDataRepository {
+    private static __instance;
+    private __fields;
+    private constructor();
+    initialize(approach: ProcessApproachEnum): void;
+    static getInstance(): GlobalDataRepository;
+    registerProperty(semanticInfo: ShaderSemanticsInfo, maxCount: Count): void;
+    takeOne(shaderSemantic: ShaderSemanticsEnum, arrayIndex?: Index): any;
+    setValue(shaderSemantic: ShaderSemanticsEnum, countIndex: Index, value: any, arrayIndex?: Index): void;
+    getValue(shaderSemantic: ShaderSemanticsEnum, countIndex: Index, arrayIndex?: Index): any;
+    getGlobalPropertyStruct(propertyIndex: Index): GlobalPropertyStruct | undefined;
+    getGlobalProperties(): GlobalPropertyStruct[];
+    setUniformLocationsForUniformModeOnly(shaderProgramUid: CGAPIResourceHandle): void;
+    setUniformValues(shaderProgram: WebGLProgram): void;
+    getLocationOffsetOfProperty(propertyIndex: Index): IndexOf16Bytes;
+    getCurrentDataNumberOfTheProperty(propertyIndex: Index): number;
+    addPropertiesStr(vertexPropertiesStr: string, pixelPropertiesStr: string, propertySetter: getShaderPropertyFunc, isWebGL2: boolean): string[];
+}
+export {};

package/dist/esm/foundation/core/MemoryManager.d.ts

@@ -1,29 +1,29 @@
-import Buffer from '../memory/Buffer';
-import { BufferUseEnum } from '../definitions/BufferUse';
-import { Size, Byte } from '../../types/CommonTypes';
-import RnObject from './RnObject';
-/**
- * Usage
- * const mm = MemoryManager.getInstance();
- * this.translate = new Vector3(
- *   mm.assignMem(componentUID, propertyId, entityUID, isRendered)
- * );
- */
-export default class MemoryManager {
-    private static __instance;
-    private __buffers;
-    private __buffersOnDemand;
-    private __memorySizeRatios;
-    private constructor();
-    static createInstanceIfNotCreated(cpuGeneric: number, gpuInstanceData: number, gpuVertexData: number): MemoryManager;
-    private __makeMultipleOf4byteSize;
-    static getInstance(): MemoryManager;
-    private __createBuffer;
-    getBuffer(bufferUse: BufferUseEnum): Buffer | undefined;
-    createOrGetBuffer(bufferUse: BufferUseEnum): Buffer;
-    createBufferOnDemand(size: Byte, object: RnObject, byteAlign: Byte): Buffer;
-    getBufferOnDemand(object: RnObject): Buffer | undefined;
-    static get bufferWidthLength(): Size;
-    static get bufferHeightLength(): Size;
-    printMemoryUsage(): void;
-}
+import Buffer from '../memory/Buffer';
+import { BufferUseEnum } from '../definitions/BufferUse';
+import { Size, Byte } from '../../types/CommonTypes';
+import RnObject from './RnObject';
+/**
+ * Usage
+ * const mm = MemoryManager.getInstance();
+ * this.translate = new Vector3(
+ *   mm.assignMem(componentUID, propertyId, entityUID, isRendered)
+ * );
+ */
+export default class MemoryManager {
+    private static __instance;
+    private __buffers;
+    private __buffersOnDemand;
+    private __memorySizeRatios;
+    private constructor();
+    static createInstanceIfNotCreated(cpuGeneric: number, gpuInstanceData: number, gpuVertexData: number): MemoryManager;
+    private __makeMultipleOf4byteSize;
+    static getInstance(): MemoryManager;
+    private __createBuffer;
+    getBuffer(bufferUse: BufferUseEnum): Buffer | undefined;
+    createOrGetBuffer(bufferUse: BufferUseEnum): Buffer;
+    createBufferOnDemand(size: Byte, object: RnObject, byteAlign: Byte): Buffer;
+    getBufferOnDemand(object: RnObject): Buffer | undefined;
+    static get bufferWidthLength(): Size;
+    static get bufferHeightLength(): Size;
+    printMemoryUsage(): void;
+}

package/dist/esm/foundation/core/RnObject.d.ts

@@ -1,96 +1,96 @@
-import { RnTags, ObjectUID } from '../../types/CommonTypes';
-export declare type Tag = {
-    tag: string;
-    value: any;
-};
-/**
- * The root class of the objects in Rhodonite
- */
-export default class RnObject {
-    static readonly InvalidObjectUID = -1;
-    static currentMaxObjectCount: number;
-    private static __uniqueNames;
-    private static __objectsByNameMap;
-    private static __objects;
-    private readonly __objectUid;
-    private __uniqueName;
-    private __tags;
-    private __combinedTagString;
-    constructor();
-    static searchByTag(tag: string, value: string): RnObject | undefined;
-    /**
-     * Gets the objectUID of the object.
-     */
-    get objectUID(): ObjectUID;
-    /**
-     * Gets the object by corresponding to the objectUID.
-     * @param objectUid The objectUID of the object.
-     */
-    static getRnObject(objectUid: ObjectUID): RnObject;
-    /**
-     * Gets the object by the unique name.
-     * @param uniqueName The unique name of the object.
-     */
-    static getRnObjectByName(uniqueName: string): RnObject | undefined;
-    /**
-     * Try to set a unique name of the entity.
-     * @param name
-     * @param toAddNameIfConflict If true, force to add name string to the current unique name string. If false, give up to change name.
-     */
-    tryToSetUniqueName(name: string, toAddNameIfConflict: boolean): boolean;
-    /**
-     * Validate the string of tags.
-     * @param val The string to be validated
-     */
-    validateTagString(val: string): boolean;
-    /**
-     * Tries to set tag (name and value).
-     * @param tagName The tag name.
-     * @param tagValue Tha value of the tag.
-     */
-    tryToSetTag(tag: Tag): boolean;
-    /**
-     * Gets the value of the tag.
-     * @param tagName The tag name.
-     */
-    getTagValue(tagName: string): any;
-    /**
-     * Gets the tag object.
-     * @param tagName The tag name.
-     */
-    getTag(tagName: string): Tag;
-    /**
-     * Gets the boolean value whether this object has the tag or not.
-     * @param tagName The tag name.
-     */
-    hasTag(tagName: string): boolean;
-    /**
-     * Remove the tag.
-     * @param tagName The tag name.
-     */
-    removeTag(tagName: string): void;
-    /**
-     * Confirms the matching of the tag name and tag value.
-     * @param tagName The tag name.
-     * @param tagValue The tag value.
-     */
-    matchTag(tagName: string, tagValue: string): boolean;
-    /**
-     * Confirm that this object's tags includes given an array of string.
-     * @param stringArray an array of string.
-     */
-    matchTagsAsFreeStrings(stringArray: string[]): boolean;
-    /**
-     * Confirm that this object's tags includes given set of tags.
-     * @param tags The set of tags.
-     */
-    matchTags(tags: RnTags): boolean;
-    /**
-     * Get the unique name of the entity.
-     */
-    get uniqueName(): string;
-    /**
-     * @private
-     */
-    static _reset(): void;
-}
+import { RnTags, ObjectUID } from '../../types/CommonTypes';
+export declare type Tag = {
+    tag: string;
+    value: any;
+};
+/**
+ * The root class of the objects in Rhodonite
+ */
+export default class RnObject {
+    static readonly InvalidObjectUID = -1;
+    static currentMaxObjectCount: number;
+    private static __uniqueNames;
+    private static __objectsByNameMap;
+    private static __objects;
+    private readonly __objectUid;
+    private __uniqueName;
+    private __tags;
+    private __combinedTagString;
+    constructor();
+    static searchByTag(tag: string, value: string): RnObject | undefined;
+    /**
+     * Gets the objectUID of the object.
+     */
+    get objectUID(): ObjectUID;
+    /**
+     * Gets the object by corresponding to the objectUID.
+     * @param objectUid The objectUID of the object.
+     */
+    static getRnObject(objectUid: ObjectUID): RnObject;
+    /**
+     * Gets the object by the unique name.
+     * @param uniqueName The unique name of the object.
+     */
+    static getRnObjectByName(uniqueName: string): RnObject | undefined;
+    /**
+     * Try to set a unique name of the entity.
+     * @param name
+     * @param toAddNameIfConflict If true, force to add name string to the current unique name string. If false, give up to change name.
+     */
+    tryToSetUniqueName(name: string, toAddNameIfConflict: boolean): boolean;
+    /**
+     * Validate the string of tags.
+     * @param val The string to be validated
+     */
+    validateTagString(val: string): boolean;
+    /**
+     * Tries to set tag (name and value).
+     * @param tagName The tag name.
+     * @param tagValue Tha value of the tag.
+     */
+    tryToSetTag(tag: Tag): boolean;
+    /**
+     * Gets the value of the tag.
+     * @param tagName The tag name.
+     */
+    getTagValue(tagName: string): any;
+    /**
+     * Gets the tag object.
+     * @param tagName The tag name.
+     */
+    getTag(tagName: string): Tag;
+    /**
+     * Gets the boolean value whether this object has the tag or not.
+     * @param tagName The tag name.
+     */
+    hasTag(tagName: string): boolean;
+    /**
+     * Remove the tag.
+     * @param tagName The tag name.
+     */
+    removeTag(tagName: string): void;
+    /**
+     * Confirms the matching of the tag name and tag value.
+     * @param tagName The tag name.
+     * @param tagValue The tag value.
+     */
+    matchTag(tagName: string, tagValue: string): boolean;
+    /**
+     * Confirm that this object's tags includes given an array of string.
+     * @param stringArray an array of string.
+     */
+    matchTagsAsFreeStrings(stringArray: string[]): boolean;
+    /**
+     * Confirm that this object's tags includes given set of tags.
+     * @param tags The set of tags.
+     */
+    matchTags(tags: RnTags): boolean;
+    /**
+     * Get the unique name of the entity.
+     */
+    get uniqueName(): string;
+    /**
+     * @private
+     */
+    static _reset(): void;
+}

package/dist/esm/foundation/definitions/AlphaMode.d.ts

@@ -1,15 +1,15 @@
-import { EnumIO } from '../misc/EnumIO';
-export declare type AlphaModeEnum = EnumIO;
-declare function from(index: number): AlphaModeEnum | undefined;
-declare function fromString(str: string): AlphaModeEnum | undefined;
-declare function fromGlTFString(str: string): AlphaModeEnum | undefined;
-export declare const AlphaMode: Readonly<{
-    Opaque: EnumIO;
-    Mask: EnumIO;
-    Translucent: EnumIO;
-    Additive: EnumIO;
-    from: typeof from;
-    fromString: typeof fromString;
-    fromGlTFString: typeof fromGlTFString;
-}>;
-export {};
+import { EnumIO } from '../misc/EnumIO';
+export declare type AlphaModeEnum = EnumIO;
+declare function from(index: number): AlphaModeEnum | undefined;
+declare function fromString(str: string): AlphaModeEnum | undefined;
+declare function fromGlTFString(str: string): AlphaModeEnum | undefined;
+export declare const AlphaMode: Readonly<{
+    Opaque: EnumIO;
+    Mask: EnumIO;
+    Translucent: EnumIO;
+    Additive: EnumIO;
+    from: typeof from;
+    fromString: typeof fromString;
+    fromGlTFString: typeof fromGlTFString;
+}>;
+export {};