isContainer
function isContainer(entity): entity is ContainerEntity;
Function: isContainer()
function isContainer(entity): entity is ContainerEntity;Defined in: packages/motion/src/Entity.ts:441
Whether an entity can hold children. Previously this was "does its data
have a children field", answerable only at runtime because entity shapes
were unknowable; now it is a property of the tag.
Parameters
| Parameter | Type |
|---|---|
entity | | { audio: { id: string; }; gain: number; loop: boolean; playing: boolean; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; time: number; } | { end: { x: number; y: number; z: number; }; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; start: { x: number; y: number; z: number; }; strokeColor: Color; strokeWidth: number; visible: boolean; } | { commands: readonly [ | { } | { x: number; y: number; z?: number; } | { x: number; y: number; z?: number; }, | { } | { x: number; y: number; z?: number; } | { x: number; y: number; z?: number; }]; fillColor: Color; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; } | { fillColor: Color; height: number; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; width: number; } | { fillColor: Color; opacity: number; position: { x: number; y: number; z: number; }; radius: number; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; } | { fillColor: Color; opacity: number; position: { x: number; y: number; z: number; }; radiusX: number; radiusY: number; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; strokeColor?: Color; strokeWidth: number; visible: boolean; } | { baseline?: "middle" | "auto" | "hanging"; fillColor: Color; fontFamily: { id: string; }; fontSize: number; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; text: string; textAnchor?: "start" | "end" | "middle"; visible: boolean; } | { children: readonly string[]; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; visible: boolean; } | { children: readonly string[]; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; visible: boolean; } | { height?: number; image: { id: string; }; opacity: number; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; scale: { x: number; y: number; z: number; }; visible: boolean; width?: number; } | { aperture: number; focalLength: number; focusDistance: number; poi: | { x: number; y: number; z: number; } | null; position: { x: number; y: number; z: number; }; rotation: { x: number; y: number; z: number; }; } |
Returns
entity is ContainerEntity