Component | rhodonite

Component is a functional unit that can be added to an Entity instance.

Hierarchy

RnObject
- Component

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new Component(entityUid: number, componentSid: number, entityRepository: EntityRepository): Component

Overrides RnObject.constructor
- Defined in foundation/core/Component.ts:97
The constructor of the Component class. When creating an Component, use the createComponent method of the ComponentRepository class instead of directly calling this constructor.

Parameters
- entityUid: number
  
  Unique ID of the corresponding entity
- componentSid: number
  
  Scoped ID of the Component
- entityRepository: EntityRepository
  
  The instance of the EntityRepository class (Dependency Injection)
Returns Component

Properties

Private __byteOffsetOfThisComponent

__byteOffsetOfThisComponent: number = -1

Protected __currentProcessStage

__currentProcessStage: ProcessStageEnum = ProcessStage.Create

Protected __entityRepository

__entityRepository: EntityRepository

the instance of EntityRepository

Protected __entityUid

__entityUid: number

the entity unique Id which this component belongs to

Private __maxComponentNumber

__maxComponentNumber: number = Config.maxEntityNumber

the MaxComponent Number of entities

Protected __memoryManager

__memoryManager: MemoryManager

the instance of MemoryManager

Private _component_sid

_component_sid: number

_isAlive

_isAlive: boolean = true

Static Readonly InvalidObjectUID

InvalidObjectUID: -1 = -1

Static Private __accessors

__accessors: Map<Function, Map<string, Accessor>> = ...

Static Private __bufferViews

__bufferViews: Map<Function, Map<EnumIO, BufferView>> = ...

Static Private __byteLengthSumOfMembers

__byteLengthSumOfMembers: Map<Function, Map<EnumIO, number>> = ...

Static Protected __componentsOfProcessStages

__componentsOfProcessStages: Map<ProcessStageEnum, Int32Array> = ...

Static Protected __lengthOfArrayOfProcessStages

__lengthOfArrayOfProcessStages: Map<ProcessStageEnum, number> = ...

Static Private __memberInfo

__memberInfo: Map<Function, MemberInfo[]> = ...

Static Private __members

__members: Map<Function, Map<EnumIO, MemberInfo[]>> = ...

Static Readonly _processStages

_processStages: ProcessStageEnum[] = ...

Static currentMaxObjectCount

currentMaxObjectCount: number = 0

Static Readonly invalidComponentSID

invalidComponentSID: -1 = -1

Accessors

componentSID

get componentSID(): number

- Defined in foundation/core/Component.ts:161
Get the Scoped ID of the Component

Returns number

currentProcessStage

get currentProcessStage(): ProcessStageEnum

- Defined in foundation/core/Component.ts:175
Get the current process stage of the component.

Returns ProcessStageEnum

entity

get entity(): IEntity

- Defined in foundation/core/Component.ts:555
get the entity which has this component.

Returns IEntity
the entity which has this component

entityUID

get entityUID(): number

- Defined in foundation/core/Component.ts:168
Get the unique ID of the entity corresponding to the component.

Returns number

maxNumberOfComponent

get maxNumberOfComponent(): number

- Defined in foundation/core/Component.ts:147
Get the max number of components

Returns number

objectUID

get objectUID(): number

Inherited from RnObject.objectUID
- Defined in foundation/core/RnObject.ts:68
Gets the objectUID of the object.

Returns number

uniqueName

get uniqueName(): string

Inherited from RnObject.uniqueName
- Defined in foundation/core/RnObject.ts:238
Get the unique name of the entity.

Returns string

Static componentTID

get componentTID(): number

- Defined in foundation/core/Component.ts:154
Get the Type ID of the Component

Returns number

Methods

_copyFrom

_copyFrom(rnObject: RnObject): void

Inherited from RnObject._copyFrom
- Defined in foundation/core/RnObject.ts:252
Parameters
- rnObject: RnObject
Returns void

_destroy

_destroy(): void

- Defined in foundation/core/Component.ts:754
internal
Mark the component as destroyed

Returns void

_setMaxNumberOfComponent

_setMaxNumberOfComponent(value: number): void

- Defined in foundation/core/Component.ts:140
internal
set the Max number of components this method is called by the ***Component classes only

Parameters
- value: number
Returns void

addThisComponentToEntity

addThisComponentToEntity<EntityBase, SomeComponentClass>(base: EntityBase, _componentClass: SomeComponentClass): EntityBase & IsThisSparkGear<SomeComponentClass, IsThisEffekseer<SomeComponentClass, IsThisPhysics<SomeComponentClass, IsThisBlendShape<SomeComponentClass, IsThisSkeletal<SomeComponentClass, IsThisLight<SomeComponentClass, IsThisCamera<SomeComponentClass, IsThisCameraController<SomeComponentClass, IsThisMeshRenderer<SomeComponentClass, IsThisMesh<SomeComponentClass, IsThisSceneGraph<SomeComponentClass, IsThisTransform<SomeComponentClass, IsThisAnimation<SomeComponentClass, AllWellKnownComponentMethodsTypes>>>>>>>>>>>>>

- Defined in foundation/core/Component.ts:672
virtual
Add this component to the entity

Type Parameters
- EntityBase extends IEntity
- SomeComponentClass extends typeof Component
Parameters
- base: EntityBase
  
  the target entity
- _componentClass: SomeComponentClass
  
  the component class to add
Returns EntityBase & IsThisSparkGear<SomeComponentClass, IsThisEffekseer<SomeComponentClass, IsThisPhysics<SomeComponentClass, IsThisBlendShape<SomeComponentClass, IsThisSkeletal<SomeComponentClass, IsThisLight<SomeComponentClass, IsThisCamera<SomeComponentClass, IsThisCameraController<SomeComponentClass, IsThisMeshRenderer<SomeComponentClass, IsThisMesh<SomeComponentClass, IsThisSceneGraph<SomeComponentClass, IsThisTransform<SomeComponentClass, IsThisAnimation<SomeComponentClass, AllWellKnownComponentMethodsTypes>>>>>>>>>>>>>

getDataByteInfo

getDataByteInfo(memberName: string): { byteLength: number; byteOffsetInBuffer: number; byteOffsetInThisComponent: any; componentNumber: number; locationOffsetInBuffer: number; locationOffsetInThisComponent: any; thisComponentByteOffsetInBuffer: number; thisComponentLocationOffsetInBuffer: number }

- Defined in foundation/core/Component.ts:600
get the bytes Information of the member

Parameters
- memberName: string
  
  the member of component in string
Returns { byteLength: number; byteOffsetInBuffer: number; byteOffsetInThisComponent: any; componentNumber: number; locationOffsetInBuffer: number; locationOffsetInThisComponent: any; thisComponentByteOffsetInBuffer: number; thisComponentLocationOffsetInBuffer: number }
bytes information
- byteLength: number
- byteOffsetInBuffer: number
- byteOffsetInThisComponent: any
- componentNumber: number
- locationOffsetInBuffer: number
- locationOffsetInThisComponent: any
- thisComponentByteOffsetInBuffer: number
- thisComponentLocationOffsetInBuffer: number

getTag

getTag(tagName: string): Tag

Inherited from RnObject.getTag
- Defined in foundation/core/RnObject.ts:156
Gets the tag object.

Parameters
- tagName: string
  
  The tag name.
Returns Tag

getTagValue

getTagValue(tagName: string): any

Inherited from RnObject.getTagValue
- Defined in foundation/core/RnObject.ts:148
Gets the value of the tag.

Parameters
- tagName: string
  
  The tag name.
Returns any

hasTag

hasTag(tagName: string): boolean

Inherited from RnObject.hasTag
- Defined in foundation/core/RnObject.ts:168
Gets the boolean value whether this object has the tag or not.

Parameters
- tagName: string
  
  The tag name.
Returns boolean

isExistProcessStageMethod

isExistProcessStageMethod(processStage: ProcessStageEnum): boolean

- Defined in foundation/core/Component.ts:197
Get true or false whether the specified ProcessStage exists in Component.

Parameters
- processStage: ProcessStageEnum
Returns boolean

matchTag

matchTag(tagName: string, tagValue: string): boolean

Inherited from RnObject.matchTag
- Defined in foundation/core/RnObject.ts:191
Confirms the matching of the tag name and tag value.

Parameters
- tagName: string
  
  The tag name.
- tagValue: string
  
  The tag value.
Returns boolean

matchTags

matchTags(tags: RnTags): boolean

Inherited from RnObject.matchTags
- Defined in foundation/core/RnObject.ts:221
Confirm that this object's tags includes given set of tags.

Parameters
- tags: RnTags
  
  The set of tags.
Returns boolean

matchTagsAsFreeStrings

matchTagsAsFreeStrings(stringArray: string[]): boolean

Inherited from RnObject.matchTagsAsFreeStrings
- Defined in foundation/core/RnObject.ts:203
Confirm that this object's tags includes given an array of string.

Parameters
- stringArray: string[]
  
  an array of string.
Returns boolean

moveStageTo

moveStageTo(processStage: ProcessStageEnum): void

- Defined in foundation/core/Component.ts:129
Move to the other stages of process

Parameters
- processStage: ProcessStageEnum
  
  stage of component's process
Returns void

registerDependency

registerDependency(component: Component, isMust: boolean): void

- Defined in foundation/core/Component.ts:308
register a dependency for the other components. Note: This method is not used yet

Parameters
- component: Component
- isMust: boolean
Returns void

registerMember

registerMember(bufferUse: EnumIO, memberName: string, dataClassType: unknown, componentType: ComponentTypeEnum, initValues: number[]): void

- Defined in foundation/core/Component.ts:440
Register a member field of component class for memory allocation.

Parameters
- bufferUse: EnumIO
  
  purpose type of buffer use
- memberName: string
  
  the name of member field
- dataClassType: unknown
  
  a class of data
- componentType: ComponentTypeEnum
  
  a type of number
- initValues: number[]
  
  a initial value
Returns void

removeTag

removeTag(tagName: string): void

Inherited from RnObject.removeTag
- Defined in foundation/core/RnObject.ts:180
Remove the tag.

Parameters
- tagName: string
  
  The tag name.
Returns void

submitToAllocation

submitToAllocation(count: number): void

- Defined in foundation/core/Component.ts:466
Allocate memory of self member fields

Parameters
- count: number
  
  a number of entities to need allocate
Returns void

takeOne

takeOne(memberName: string, dataClassType: any, initValues: number[]): any

- Defined in foundation/core/Component.ts:341
take one memory area for the specified member for all same type of the component instances.

Parameters
- memberName: string
- dataClassType: any
- initValues: number[]
Returns any

tryToSetTag

tryToSetTag(tag: Tag): boolean

Inherited from RnObject.tryToSetTag
- Defined in foundation/core/RnObject.ts:131
Tries to set tag (name and value).

Parameters
- tag: Tag
Returns boolean

tryToSetUniqueName

tryToSetUniqueName(name: string, toAddNameIfConflict: boolean): boolean

Inherited from RnObject.tryToSetUniqueName
- Defined in foundation/core/RnObject.ts:93
Try to set a unique name of the entity.

Parameters
- name: string
- toAddNameIfConflict: boolean
  
  If true, force to add name string to the current unique name string. If false, give up to change name.
Returns boolean

validateTagString

validateTagString(val: string): boolean

Inherited from RnObject.validateTagString
- Defined in foundation/core/RnObject.ts:118
Validate the string of tags.

Parameters
- val: string
  
  The string to be validated
Returns boolean

Static _reset

_reset(): void

Inherited from RnObject._reset
- Defined in foundation/core/RnObject.ts:245
internal
Returns void

Static doesTheProcessStageMethodExist

doesTheProcessStageMethodExist(componentType: typeof Component, processStage: ProcessStageEnum): boolean

- Defined in foundation/core/Component.ts:183
Get true or false whether the specified ProcessStage exists in Component.

Parameters
- componentType: typeof Component
- processStage: ProcessStageEnum
Returns boolean
true or false

Static getAccessor

getAccessor(memberName: string, componentClass: Function): Accessor

- Defined in foundation/core/Component.ts:361
get the taken accessor for the member field.

Parameters
- memberName: string
- componentClass: Function
Returns Accessor

Static getByteLengthSumOfMembers

getByteLengthSumOfMembers(bufferUse: EnumIO, componentClass: Function): number

- Defined in foundation/core/Component.ts:295
get byte length of sum of member fields in the component class

Parameters
- bufferUse: EnumIO
- componentClass: Function
Returns number

Static getByteOffsetOfFirstOfThisMemberInBuffer

getByteOffsetOfFirstOfThisMemberInBuffer(memberName: string, componentClass: Function): number

- Defined in foundation/core/Component.ts:416
Parameters
- memberName: string
- componentClass: Function
Returns number

Static getByteOffsetOfFirstOfThisMemberInBufferView

getByteOffsetOfFirstOfThisMemberInBufferView(memberName: string, componentClass: Function): number

- Defined in foundation/core/Component.ts:424
Parameters
- memberName: string
- componentClass: Function
Returns number

Static getByteOffsetOfThisComponentTypeInBuffer

getByteOffsetOfThisComponentTypeInBuffer(bufferUse: EnumIO, componentClass: Function): number

- Defined in foundation/core/Component.ts:408
Parameters
- bufferUse: EnumIO
- componentClass: Function
Returns number

Static getComponentTypeOfMember

getComponentTypeOfMember(memberName: string, componentClass: Function): undefined | ComponentTypeEnum

- Defined in foundation/core/Component.ts:735
Get the ComponentType of the member

Parameters
- memberName: string
  
  the member name
- componentClass: Function
  
  the component class
Returns undefined | ComponentTypeEnum
ComponentType or undefined

Static getCompositionTypeOfMember

getCompositionTypeOfMember(memberName: string, componentClass: Function): undefined | CompositionTypeEnum

- Defined in foundation/core/Component.ts:714
Get the CompositionType of the member

Parameters
- memberName: string
  
  the member name
- componentClass: Function
  
  the component class
Returns undefined | CompositionTypeEnum
CompositionType or undefined

Static getDataByteInfoByComponentSID

getDataByteInfoByComponentSID(componentType: typeof Component, componentSID: number, memberName: string): undefined | { byteLength: number; byteOffsetInBuffer: number; byteOffsetInThisComponent: any; componentNumber: number; locationOffsetInBuffer: number; locationOffsetInThisComponent: any; thisComponentByteOffsetInBuffer: number; thisComponentLocationOffsetInBuffer: number }

- Defined in foundation/core/Component.ts:611
get the bytes Information of the member (static version) by ComponentSID

Parameters
- componentType: typeof Component
  
  the Component type
- componentSID: number
  
  the ComponentSID of the component
- memberName: string
  
  the member of component in string
Returns undefined | { byteLength: number; byteOffsetInBuffer: number; byteOffsetInThisComponent: any; componentNumber: number; locationOffsetInBuffer: number; locationOffsetInThisComponent: any; thisComponentByteOffsetInBuffer: number; thisComponentLocationOffsetInBuffer: number }
bytes information

Static getDataByteInfoByEntityUID

getDataByteInfoByEntityUID(componentType: typeof Component, entityUID: number, memberName: string): undefined | { byteLength: number; byteOffsetInBuffer: number; byteOffsetInThisComponent: any; componentNumber: number; locationOffsetInBuffer: number; locationOffsetInThisComponent: any; thisComponentByteOffsetInBuffer: number; thisComponentLocationOffsetInBuffer: number }

- Defined in foundation/core/Component.ts:634
get the bytes Information of the member (static version) by EntityUID

Parameters
- componentType: typeof Component
  
  the component type
- entityUID: number
  
  the EntityUID
- memberName: string
  
  the member of component in string
Returns undefined | { byteLength: number; byteOffsetInBuffer: number; byteOffsetInThisComponent: any; componentNumber: number; locationOffsetInBuffer: number; locationOffsetInThisComponent: any; thisComponentByteOffsetInBuffer: number; thisComponentLocationOffsetInBuffer: number }
bytes information

Static getDataByteInfoInner

getDataByteInfoInner(component: Component, memberName: string): { byteLength: number; byteOffsetInBuffer: number; byteOffsetInThisComponent: any; componentNumber: number; locationOffsetInBuffer: number; locationOffsetInThisComponent: any; thisComponentByteOffsetInBuffer: number; thisComponentLocationOffsetInBuffer: number }

- Defined in foundation/core/Component.ts:565
get the bytes Information of the member

Parameters
- component: Component
  
  a instance of the component
- memberName: string
  
  the member of component in string
Returns { byteLength: number; byteOffsetInBuffer: number; byteOffsetInThisComponent: any; componentNumber: number; locationOffsetInBuffer: number; locationOffsetInThisComponent: any; thisComponentByteOffsetInBuffer: number; thisComponentLocationOffsetInBuffer: number }
bytes information
- byteLength: number
- byteOffsetInBuffer: number
- byteOffsetInThisComponent: any
- componentNumber: number
- locationOffsetInBuffer: number
- locationOffsetInThisComponent: any
- thisComponentByteOffsetInBuffer: number
- thisComponentLocationOffsetInBuffer: number

Static getLocationOffsetOfMemberOfComponent

getLocationOffsetOfMemberOfComponent(componentType: typeof Component, memberName: string): number

- Defined in foundation/core/Component.ts:656
get the Pixel Location Offset in the Buffer of the Member

Parameters
- componentType: typeof Component
  
  the component type (e.g. TransformComponent )
- memberName: string
  
  the member name in string
Returns number
the pixel offsets

Static getRnObject

getRnObject(objectUid: number): RnObject

Inherited from RnObject.getRnObject
- Defined in foundation/core/RnObject.ts:76
Gets the object by corresponding to the objectUID.

Parameters
- objectUid: number
  
  The objectUID of the object.
Returns RnObject

Static getRnObjectByName

getRnObjectByName(uniqueName: string): undefined | RnObject

Inherited from RnObject.getRnObjectByName
- Defined in foundation/core/RnObject.ts:84
Gets the object by the unique name.

Parameters
- uniqueName: string
  
  The unique name of the object.
Returns undefined | RnObject

Static process

process(param0: { componentType: typeof Component; processApproach: ProcessApproachClass; processStage: ProcessStageEnum; renderPass?: RenderPass; renderPassTickCount: number; strategy: WebGLStrategy }): void

- Defined in foundation/core/Component.ts:209
Process the components

Parameters
- param0: { componentType: typeof Component; processApproach: ProcessApproachClass; processStage: ProcessStageEnum; renderPass?: RenderPass; renderPassTickCount: number; strategy: WebGLStrategy }
  
  params
  - componentType: typeof Component
  - processApproach: ProcessApproachClass
  - processStage: ProcessStageEnum
  - Optional renderPass?: RenderPass
  - renderPassTickCount: number
  - strategy: WebGLStrategy
Returns void

Static searchByTag

searchByTag(tag: string, value: string): undefined | RnObject

Inherited from RnObject.searchByTag
- Defined in foundation/core/RnObject.ts:56
Parameters
- tag: string
- value: string
Returns undefined | RnObject

Static takeAccessor

takeAccessor(bufferUse: EnumIO, memberName: string, componentClass: Function, compositionType: CompositionTypeEnum, componentType: ComponentTypeEnum, count: number): undefined | Accessor

- Defined in foundation/core/Component.ts:368
take one accessor for the member field.

Parameters
- bufferUse: EnumIO
- memberName: string
- componentClass: Function
- compositionType: CompositionTypeEnum
- componentType: ComponentTypeEnum
- count: number
Returns undefined | Accessor

Static updateComponentsOfEachProcessStage

updateComponentsOfEachProcessStage(componentClass: typeof Component, processStage: ProcessStageEnum, renderPass?: RenderPass): void

- Defined in foundation/core/Component.ts:256
Update all components at each process stage.

Parameters
- componentClass: typeof Component
- processStage: ProcessStageEnum
- Optional renderPass: RenderPass
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

entityUid: number

componentSid: number

entityRepository: EntityRepository

Returns Component

Properties

Private __byteOffsetOfThisComponent

Protected __currentProcessStage

Protected __entityRepository

Protected __entityUid

Private __maxComponentNumber

Protected __memoryManager

Private _component_sid

_isAlive

Static Readonly InvalidObjectUID

Static Private __accessors

Static Private __bufferViews

Static Private __byteLengthSumOfMembers

Static Protected __componentsOfProcessStages

Static Protected __lengthOfArrayOfProcessStages

Static Private __memberInfo

Static Private __members

Static Readonly _processStages

Static currentMaxObjectCount

Static Readonly invalidComponentSID

Accessors

componentSID

Returns number

currentProcessStage

Returns ProcessStageEnum

entity

Returns IEntity

entityUID

Returns number

maxNumberOfComponent

Returns number

objectUID

Returns number

uniqueName

Returns string

Static componentTID

Returns number

Methods

_copyFrom

Parameters

rnObject: RnObject

Returns void

_destroy

Returns void

_setMaxNumberOfComponent

Parameters

value: number

Returns void

addThisComponentToEntity

Type Parameters

EntityBase extends IEntity

SomeComponentClass extends typeof Component

Parameters

base: EntityBase

_componentClass: SomeComponentClass

getDataByteInfo

Parameters

memberName: string

Returns { byteLength: number; byteOffsetInBuffer: number; byteOffsetInThisComponent: any; componentNumber: number; locationOffsetInBuffer: number; locationOffsetInThisComponent: any; thisComponentByteOffsetInBuffer: number; thisComponentLocationOffsetInBuffer: number }

byteLength: number

byteOffsetInBuffer: number

byteOffsetInThisComponent: any

componentNumber: number

locationOffsetInBuffer: number

locationOffsetInThisComponent: any

thisComponentByteOffsetInBuffer: number

thisComponentLocationOffsetInBuffer: number