Class StaticEntity`Abstract`

Hierarchy (view full)

BaseEntity
- StaticEntity

Constructors

constructor

new StaticEntity(_app): StaticEntity
Parameters
- _app: App
Returns StaticEntity
Inherited from BaseEntity.constructor
- Defined in src/ts/entities/abstract/baseEntity.ts:148

Properties

`Protected`_app

_app: App

`Protected`_boundingBox

_boundingBox: Nullable<BoundingBox> = null

`Protected`_cachedNode

_cachedNode: Nullable<Group> = null

`Protected`_currentKonvasDrawContext

_currentKonvasDrawContext: Nullable<DrawContext> = null

`Protected`_isKonvasCacheDirty

_isKonvasCacheDirty: boolean = false

`Readonly`_isStatic

_isStatic = true

`Protected`_konvasCache

_konvasCache: null | KonvasCache<Record<string, Shape<ShapeConfig> | Group | LabelContainer[]>> = null

disabled

disabled: boolean = false

highlight

highlight: TrackableProperty<boolean> = ...

hitBoxes

hitBoxes: HitBox[] = []

hover

hover: TrackableProperty<boolean> = ...

isReady

isReady: boolean = false

metadata

metadata: any = {}

onHoverTimer

onHoverTimer: null | Timeout = null

Accessors

boundingBox

get boundingBox(): Nullable<BoundingBox>
Returns Nullable<BoundingBox>
Inherited from BaseEntity.boundingBox
- Defined in src/ts/entities/abstract/baseEntity.ts:52

`Abstract`id

get id(): string
Returns string
Inherited from BaseEntity.id
- Defined in src/ts/entities/abstract/baseEntity.ts:61

konvasCache

get konvasCache(): null | KonvasCache<Record<string, Shape<ShapeConfig> | Group | LabelContainer[]>>
Returns null | KonvasCache<Record<string, Shape<ShapeConfig> | Group | LabelContainer[]>>
Inherited from BaseEntity.konvasCache
- Defined in src/ts/entities/abstract/baseEntity.ts:137

Methods

`Protected`_clearKonvasCache

_clearKonvasCache(): void
Returns void
Inherited from BaseEntity._clearKonvasCache
- Defined in src/ts/entities/abstract/baseEntity.ts:110

`Protected`_computeBoundingBox

_computeBoundingBox(): void
Returns void
Inherited from BaseEntity._computeBoundingBox
- Defined in src/ts/entities/abstract/baseEntity.ts:93

`Protected` `Abstract`_createKonvasCache

_createKonvasCache(): void
Returns void
Inherited from BaseEntity._createKonvasCache
- Defined in src/ts/entities/abstract/baseEntity.ts:146

`Protected` `Abstract`_getKonvasRepresentation

_getKonvasRepresentation(context, previousContext, dirtyFlag): KonvaRepresentation
Parameters
- context: DrawContext
- previousContext: Nullable<DrawContext>
- dirtyFlag: ContextDirtyFlag
Returns KonvaRepresentation
Inherited from BaseEntity._getKonvasRepresentation
- Defined in src/ts/entities/abstract/baseEntity.ts:236

`Protected`_onHighlightChange

_onHighlightChange(_value): void
Parameters
- _value: boolean
Returns void
Inherited from BaseEntity._onHighlightChange
- Defined in src/ts/entities/abstract/baseEntity.ts:85

`Protected`_onHoverChange

_onHoverChange(_value): void
Parameters
- _value: boolean
Returns void
Inherited from BaseEntity._onHoverChange
- Defined in src/ts/entities/abstract/baseEntity.ts:89

addHitBox

addHitBox(hitBox): void
Parameters
- hitBox: HitBox
Returns void
Inherited from BaseEntity.addHitBox
- Defined in src/ts/entities/abstract/baseEntity.ts:181

addOnClickBehavior

addOnClickBehavior(params): void
Parameters
- params: {
      callback?: ((params: {
          e: KonvaEventObject<MouseEvent>;
          entity: BaseEntity;
          label?: LabelContainer;
      }) => void);
      eventType?: string;
      namespace?: string;
      targets?: (Shape<ShapeConfig> | Group)[];
  }
  - Optionalcallback?: ((params: {
        e: KonvaEventObject<MouseEvent>;
        entity: BaseEntity;
        label?: LabelContainer;
    }) => void)
    - (params): void
      Parameters
      params: {
          e: KonvaEventObject<MouseEvent>;
          entity: BaseEntity;
          label?: LabelContainer;
      }
      e: KonvaEventObject<MouseEvent>
      entity: BaseEntity
      Optionallabel?: LabelContainer
      Returns void
  - OptionaleventType?: string
  - Optionalnamespace?: string
  - Optionaltargets?: (Shape<ShapeConfig> | Group)[]
Returns void
Inherited from BaseEntity.addOnClickBehavior
- Defined in src/ts/entities/abstract/baseEntity.ts:270

disable

disable(): void
Returns void
Inherited from BaseEntity.disable
- Defined in src/ts/entities/abstract/baseEntity.ts:247

dispose

dispose(): void
Returns void
Inherited from BaseEntity.dispose
- Defined in src/ts/entities/abstract/baseEntity.ts:200

enable

enable(): void
Returns void
Inherited from BaseEntity.enable
- Defined in src/ts/entities/abstract/baseEntity.ts:252

forceUpdateBoundingBox

forceUpdateBoundingBox(): void
Returns void
Inherited from BaseEntity.forceUpdateBoundingBox
- Defined in src/ts/entities/abstract/baseEntity.ts:313

getAllKonvaNodes

getAllKonvaNodes(): Node<NodeConfig>[]
Returns Node<NodeConfig>[]
Inherited from BaseEntity.getAllKonvaNodes
- Defined in src/ts/entities/abstract/baseEntity.ts:166

getBaseGroup

getBaseGroup(): Nullable<Group>
Returns Nullable<Group>
Inherited from BaseEntity.getBaseGroup
- Defined in src/ts/entities/abstract/baseEntity.ts:154

getBaseShapes

getBaseShapes(): (Shape<ShapeConfig> | Group)[]
Returns (Shape<ShapeConfig> | Group)[]
Inherited from BaseEntity.getBaseShapes
- Defined in src/ts/entities/abstract/baseEntity.ts:158

getKonvaCacheAnchorsGroup

getKonvaCacheAnchorsGroup(): Group
Returns Group
Inherited from BaseEntity.getKonvaCacheAnchorsGroup
- Defined in src/ts/entities/abstract/baseEntity.ts:300

getKonvaCacheLabels

getKonvaCacheLabels(): LabelContainer[]
Returns LabelContainer[]
Inherited from BaseEntity.getKonvaCacheLabels
- Defined in src/ts/entities/abstract/baseEntity.ts:296

getKonvasRepresentation

getKonvasRepresentation(context, dirtyFlag, resetCacheDirtyFlag?): KonvaRepresentation
Parameters
- context: DrawContext
- dirtyFlag: ContextDirtyFlag
- resetCacheDirtyFlag: boolean = false
Returns KonvaRepresentation
Inherited from BaseEntity.getKonvasRepresentation
- Defined in src/ts/entities/abstract/baseEntity.ts:206

`Abstract`getType

getType(): string
Returns string
Inherited from BaseEntity.getType
- Defined in src/ts/entities/abstract/baseEntity.ts:152

isCacheEmpty

isCacheEmpty(): boolean
Returns boolean
Inherited from BaseEntity.isCacheEmpty
- Defined in src/ts/entities/abstract/baseEntity.ts:257

isDraggable

isDraggable(): boolean
Returns boolean
Inherited from BaseEntity.isDraggable
- Defined in src/ts/entities/abstract/baseEntity.ts:173

pickHitBoxes

pickHitBoxes(mousePosition): boolean
Parameters
- mousePosition: Vector2d
Returns boolean
Inherited from BaseEntity.pickHitBoxes
- Defined in src/ts/entities/abstract/baseEntity.ts:190

regenerateKonvaCache

regenerateKonvaCache(): void
Returns void
Inherited from BaseEntity.regenerateKonvaCache
- Defined in src/ts/entities/abstract/baseEntity.ts:242

removeClickBehaviors

removeClickBehaviors(params): void
Parameters
- params: {
  namespace?: string;
  targets?: (Shape<ShapeConfig> | Group)[];
  }
  - Optionalnamespace?: string
  - Optionaltargets?: (Shape<ShapeConfig> | Group)[]
Returns void
Inherited from BaseEntity.removeClickBehaviors
- Defined in src/ts/entities/abstract/baseEntity.ts:261

removeHitBoxes

removeHitBoxes(): void
Returns void
Inherited from BaseEntity.removeHitBoxes
- Defined in src/ts/entities/abstract/baseEntity.ts:185

resetBoundingBox

resetBoundingBox(): void
Returns void
Inherited from BaseEntity.resetBoundingBox
- Defined in src/ts/entities/abstract/baseEntity.ts:317

setHitBoxes

setHitBoxes(hitBoxes): void
Parameters
- hitBoxes: HitBox[]
Returns void
Inherited from BaseEntity.setHitBoxes
- Defined in src/ts/entities/abstract/baseEntity.ts:177

updateBoundingBox

updateBoundingBox(): void
Returns void
Inherited from BaseEntity.updateBoundingBox
- Defined in src/ts/entities/abstract/baseEntity.ts:304