rhodonite
    Preparing search index...

    Class CameraComponent

    The Component that represents a camera.

    The camera is defined such that the local +X axis is to the right, the "lens" looks towards the local -Z axis, and the top of the camera is aligned with the local +Y axis.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    __currentProcessStage __engine __entityRepository __entityUid __isReUse __memoryManager _isAlive _tags _xrLeft _xrRight isSyncToLight _processStages currentMaxObjectCount InvalidObjectUID

    Accessors

    _componentMemoryRegistry aspect aspectInner biasViewProjectionMatrix bottom bottomInner componentSID componentTID corner cornerInner currentProcessStage direction directionInner entity entityUID eye eyeInner focalLength focalLengthInner fovy fovyInner frustum left leftInner objectUID parameters parametersInner projectionMatrix right rightInner top topInner type uniqueName up updateCount upInner viewMatrix viewProjectionMatrix worldPosition xMag yMag zFar zFarInner zNear zNearInner componentTID

    Methods

    _copyFrom _destroy _shallowCopyFrom $load $logic addThisComponentToEntity calcProjectionMatrix calcViewMatrix getTag getTagValue hasTag isExistProcessStageMethod matchTag matchTags matchTagsAsFreeStrings moveStageTo registerDependency removeTag setFovyAndChangeFilmSize setFovyAndChangeFocalLength submitToAllocation tryToSetTag tryToSetUniqueName unregister updateFrustum validateTagString _cleanupForEngine _reset doesTheProcessStageMethodExist getArrayLengthOfMember getComponentCountPerBufferView getComponentTypeOfMember getCompositionTypeOfMember getCurrent getCurrentCameraUpdateCount getLocationOffsetOfMemberOfComponent getMemberInfo getRnObject getRnObjectByName getStateVersion process registerMember searchByTag setCurrent updateComponentsForRenderStage

    Constructors

    Properties

    Protected__currentProcessStage

    __currentProcessStage: ProcessStageEnum = ProcessStage.Load

    Protected__engine

    __engine: Engine

    Protected__entityRepository

    __entityRepository: EntityRepository

    the instance of EntityRepository

    Protected__entityUid

    __entityUid: number

    the entity unique Id which this component belongs to

    Protected__isReUse

    __isReUse: boolean = false

    Protected__memoryManager

    __memoryManager: MemoryManager

    the instance of MemoryManager

    _isAlive

    _isAlive: boolean = true

    _tags

    _tags: RnTags = {}

    Collection of tags associated with this object

    _xrLeft

    _xrLeft: boolean = false

    _xrRight

    _xrRight: boolean = false
    isSyncToLight: boolean = false

    Static Readonly_processStages

    _processStages: ProcessStageEnum[] = ...
    currentMaxObjectCount: number = 0

    Current maximum object count for UID generation

    InvalidObjectUID: -1

    Invalid object UID constant

    Accessors

    _componentMemoryRegistry

    • get _componentMemoryRegistry(): ComponentMemoryRegistry

      Gets the ComponentMemoryRegistry for this component's engine.

      Returns ComponentMemoryRegistry

    • get componentSID(): number

      Gets the Scoped ID of this Component instance. The SID is unique within the component type and represents the instance index.

      Returns number

      The component scoped ID

    • get entityUID(): number

      Gets the unique ID of the entity that owns this component.

      Returns number

      The entity unique ID

    • get objectUID(): number

      Gets the unique object identifier

      Returns number

      The object's UID

    • get uniqueName(): string

      Gets the unique name of this object

      Returns string

      The unique name string

    Methods

    _copyFrom

    _destroy

    _shallowCopyFrom

    • Retrieves a complete tag object (name and value) for the specified tag name

      Parameters

      • tagName: string

        The name of the tag to retrieve

      Returns Tag

      A Tag object containing the name and value

    • Retrieves the value associated with a specific tag name

      Parameters

      • tagName: string

        The name of the tag whose value to retrieve

      Returns any

      The tag value, or undefined if the tag doesn't exist

    • Checks whether this object has a tag with the specified name

      Parameters

      • tagName: string

        The name of the tag to check for

      Returns boolean

      True if the tag exists (value is not null/undefined), false otherwise

    • Checks if this object has a tag with the specified name and value

      Parameters

      • tagName: string

        The tag name to match

      • tagValue: string

        The tag value to match

      Returns boolean

      True if the object has a matching tag, false otherwise

    • Checks if this object has all the specified tags with exactly matching values

      Parameters

      • tags: RnTags

        Object containing tag names as keys and expected values

      Returns boolean

      True if all specified tags exist with matching values, false otherwise

    • Checks if the object's combined tag string contains all the provided search strings. This allows for flexible searching within tag names and values.

      Parameters

      • stringArray: string[]

        Array of strings that must all be present in the combined tag string

      Returns boolean

      True if all strings are found in the combined tag string, false otherwise

    • Registers a dependency relationship with another component. This method is intended for future use in managing component dependencies.

      Parameters

      Returns void

      This method is not used yet and needs implementation

    • Allocates memory for all member fields of this component instance. This method is called during component initialization to set up memory layout and allocate space for the specified number of entities.

      Parameters

      • componentCountPerBufferView: number

        The number of components per buffer view

      • isReUse: boolean

        Whether to reuse existing memory allocations

      Returns void

    • Attempts to set a tag on this object. If the tag already exists, it will be replaced.

      Parameters

      • tag: Tag

        The tag object containing the name and value to set

      Returns boolean

      True if the tag was successfully set, false if the tag name contains invalid characters

    • Attempts to set a unique name for this object

      Parameters

      • name: string

        The desired unique name

      • toAddNameIfConflict: boolean

        If true, appends UID to make name unique when conflicts occur; if false, fails on conflict

      Returns boolean

      True if the name was successfully set, false if there was a conflict and toAddNameIfConflict was false

    • Validates that a tag string contains only allowed characters (alphanumeric and underscore)

      Parameters

      • val: string

        The string to validate

      Returns boolean

      True if the string contains only valid characters, false if it contains invalid characters

    Static_cleanupForEngine

    Static_reset

    • Gets the pixel location offset in the buffer for a specific member of a component type. This is useful for GPU texture-based data access where locations are measured in pixels.

      Parameters

      • engine: Engine

        The engine instance

      • componentType: typeof Component

        The component class type

      • memberName: string

        The name of the member field

      Returns number[]

      The pixel location offset in the buffer

    • Retrieves an RnObject instance by its unique identifier

      Parameters

      • objectUid: number

        The unique identifier of the object to retrieve

      Returns RnObject | undefined

      The RnObject instance or undefined if not found or garbage collected

    • Processes all components of a given type for a specific process stage. This method iterates through all components of the specified type and calls their corresponding process stage method if they are in that stage.

      Parameters

      Returns void

    • Registers a member field of the component class for memory allocation. This method defines the memory layout and characteristics of component data members.

      Parameters

      • this: typeof Component
      • bufferUse: {
            arrayLength?: number;
            bufferUse: EnumIO;
            componentSID?: number;
            componentType: ComponentTypeEnum;
            compositionType: CompositionTypeEnum;
            convertToBool?: boolean;
            dataClassType: DataClassType;
            initValues: number[] | VectorN;
            memberName: string;
            shaderType: EnumIO;
        }

        The intended purpose/type of buffer use

      Returns void

    • Searches for the first object that has a specific tag with the given value

      Parameters

      • tag: string

        The tag name to search for

      • value: string

        The tag value to match

      Returns WeakRef<RnObject> | undefined

      WeakRef to the first matching object, or undefined if not found

    • Sets the current active camera component for a specific engine.

      Parameters

      • engine: Engine

        The engine instance

      • componentSID: number

        The component system identifier of the camera to set as current

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods