Skip to main content

novorender-api-docs / DataJsAPI / ObjectGroup

Interface: ObjectGroup

Scene objects group

Properties

color?

optional color: Float32Array | readonly [number, number, number] | readonly [number, number, number, number];

Group color when selected.


grouping?

optional grouping: string;

Grouping.


hidden

hidden: boolean;

Is Group hidden?


id

id: string;

Object group uuid.


ids?

optional ids: ObjectIdArray;

List of selected object id's.

Remarks

The array itself is immutable/readonly, so updates are done by assigning a new array.


includeDescendants?

optional includeDescendants: boolean;

Include descendants.

Remarks

undefined value will be interpret as true


name

name: string;

Object group name.


opacity?

optional opacity: number;

Group opacity when selected.


optional search: SearchPattern[];

Group filling search criterias.

Remarks

This search criterias will be used to refill ids array on scene rebuilding automatically. If search is not defined then ids array will remain on scene rebuilding.


selected

selected: boolean;

Is group selected?