Class RnObject

The root class of the objects in Rhodonite

Hierarchy

RnObject

Implements

IRnObject

Constructors

constructor

new RnObject(): RnObject

- Defined in foundation/core/RnObject.ts:45
Returns RnObject

Properties

Private __combinedTagString

__combinedTagString: string = ''

Private Readonly __objectUid

__objectUid: number = ...

Private __tags

__tags: RnTags = {}

Private __uniqueName

__uniqueName: string

Static Readonly InvalidObjectUID

InvalidObjectUID: -1 = -1

Static Private __objects

__objects: RnObject[] = []

Static Private __objectsByNameMap

__objectsByNameMap: Map<string, RnObject> = ...

Static Private __uniqueNames

__uniqueNames: string[] = []

Static currentMaxObjectCount

currentMaxObjectCount: number = 0

Accessors

objectUID

get objectUID(): number

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

Returns number

uniqueName

get uniqueName(): string

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

Returns string

Methods

Private __updateInfo

__updateInfo(uniqueName: string): void

- Defined in foundation/core/RnObject.ts:50
Parameters
- uniqueName: string
Returns void

_copyFrom

_copyFrom(rnObject: RnObject): void

Implementation of IRnObject._copyFrom
- Defined in foundation/core/RnObject.ts:252
Parameters
- rnObject: RnObject
Returns void

getTag

getTag(tagName: string): Tag

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

Parameters
- tagName: string
  
  The tag name.
Returns Tag

getTagValue

getTagValue(tagName: string): any

Implementation of IRnObject.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

- 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

matchTag

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

Implementation of IRnObject.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

Implementation of IRnObject.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

Implementation of IRnObject.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

removeTag

removeTag(tagName: string): void

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

Parameters
- tagName: string
  
  The tag name.
Returns void

tryToSetTag

tryToSetTag(tag: Tag): boolean

Implementation of IRnObject.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

Implementation of IRnObject.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

Implementation of IRnObject.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

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

Static getRnObject

getRnObject(objectUid: number): RnObject

- 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

- 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 searchByTag

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

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

Generated using TypeDoc