Class FamilyInstanceTable

Hierarchy

FamilyInstanceTable

Implements

IFamilyInstanceTable

Index

Constructors

Methods

get getAll getAllBasisX_X getAllBasisX_Y getAllBasisX_Z getAllBasisY_X getAllBasisY_Y getAllBasisY_Z getAllBasisZ_X getAllBasisZ_Y getAllBasisZ_Z getAllElementIndex getAllFacingFlipped getAllFacingOrientation_X getAllFacingOrientation_Y getAllFacingOrientation_Z getAllFamilyTypeIndex getAllFromRoomIndex getAllHandFlipped getAllHandOrientation_X getAllHandOrientation_Y getAllHandOrientation_Z getAllHasModifiedGeometry getAllHostIndex getAllMirrored getAllScale getAllToRoomIndex getAllTranslation_X getAllTranslation_Y getAllTranslation_Z getBasisX_X getBasisX_Y getBasisX_Z getBasisY_X getBasisY_Y getBasisY_Z getBasisZ_X getBasisZ_Y getBasisZ_Z getCount getElement getElementIndex getFacingFlipped getFacingOrientation_X getFacingOrientation_Y getFacingOrientation_Z getFamilyType getFamilyTypeIndex getFromRoom getFromRoomIndex getHandFlipped getHandOrientation_X getHandOrientation_Y getHandOrientation_Z getHasModifiedGeometry getHost getHostIndex getMirrored getScale getToRoom getToRoomIndex getTranslation_X getTranslation_Y getTranslation_Z createFromDocument

Constructors

constructor

new FamilyInstanceTable(): FamilyInstanceTable
Returns FamilyInstanceTable

Methods

get

get(familyInstanceIndex: number): Promise<IFamilyInstance>
Parameters
- familyInstanceIndex: number
Returns Promise<IFamilyInstance>
Implementation of IFamilyInstanceTable.get
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1409

getAll

getAll(): Promise<IFamilyInstance[]>
Returns Promise<IFamilyInstance[]>
Implementation of IFamilyInstanceTable.getAll
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1410

getAllBasisX_X

getAllBasisX_X(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllBasisX_X
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1428

getAllBasisX_Y

getAllBasisX_Y(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllBasisX_Y
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1430

getAllBasisX_Z

getAllBasisX_Z(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllBasisX_Z
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1432

getAllBasisY_X

getAllBasisY_X(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllBasisY_X
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1434

getAllBasisY_Y

getAllBasisY_Y(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllBasisY_Y
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1436

getAllBasisY_Z

getAllBasisY_Z(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllBasisY_Z
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1438

getAllBasisZ_X

getAllBasisZ_X(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllBasisZ_X
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1440

getAllBasisZ_Y

getAllBasisZ_Y(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllBasisZ_Y
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1442

getAllBasisZ_Z

getAllBasisZ_Z(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllBasisZ_Z
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1444

getAllElementIndex

getAllElementIndex(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllElementIndex
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1470

getAllFacingFlipped

getAllFacingFlipped(): Promise<boolean[]>
Returns Promise<boolean[]>
Implementation of IFamilyInstanceTable.getAllFacingFlipped
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1412

getAllFacingOrientation_X

getAllFacingOrientation_X(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllFacingOrientation_X
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1414

getAllFacingOrientation_Y

getAllFacingOrientation_Y(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllFacingOrientation_Y
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1416

getAllFacingOrientation_Z

getAllFacingOrientation_Z(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllFacingOrientation_Z
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1418

getAllFamilyTypeIndex

getAllFamilyTypeIndex(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllFamilyTypeIndex
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1458

getAllFromRoomIndex

getAllFromRoomIndex(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllFromRoomIndex
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1464

getAllHandFlipped

getAllHandFlipped(): Promise<boolean[]>
Returns Promise<boolean[]>
Implementation of IFamilyInstanceTable.getAllHandFlipped
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1420

getAllHandOrientation_X

getAllHandOrientation_X(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllHandOrientation_X
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1452

getAllHandOrientation_Y

getAllHandOrientation_Y(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllHandOrientation_Y
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1454

getAllHandOrientation_Z

getAllHandOrientation_Z(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllHandOrientation_Z
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1456

getAllHasModifiedGeometry

getAllHasModifiedGeometry(): Promise<boolean[]>
Returns Promise<boolean[]>
Implementation of IFamilyInstanceTable.getAllHasModifiedGeometry
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1424

getAllHostIndex

getAllHostIndex(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllHostIndex
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1461

getAllMirrored

getAllMirrored(): Promise<boolean[]>
Returns Promise<boolean[]>
Implementation of IFamilyInstanceTable.getAllMirrored
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1422

getAllScale

getAllScale(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllScale
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1426

getAllToRoomIndex

getAllToRoomIndex(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllToRoomIndex
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1467

getAllTranslation_X

getAllTranslation_X(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllTranslation_X
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1446

getAllTranslation_Y

getAllTranslation_Y(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllTranslation_Y
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1448

getAllTranslation_Z

getAllTranslation_Z(): Promise<number[]>
Returns Promise<number[]>
Implementation of IFamilyInstanceTable.getAllTranslation_Z
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1450

getBasisX_X

getBasisX_X(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getBasisX_X
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1427

getBasisX_Y

getBasisX_Y(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getBasisX_Y
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1429

getBasisX_Z

getBasisX_Z(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getBasisX_Z
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1431

getBasisY_X

getBasisY_X(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getBasisY_X
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1433

getBasisY_Y

getBasisY_Y(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getBasisY_Y
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1435

getBasisY_Z

getBasisY_Z(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getBasisY_Z
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1437

getBasisZ_X

getBasisZ_X(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getBasisZ_X
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1439

getBasisZ_Y

getBasisZ_Y(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getBasisZ_Y
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1441

getBasisZ_Z

getBasisZ_Z(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getBasisZ_Z
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1443

getCount

getCount(): Promise<number>
Returns Promise<number>
Implementation of IFamilyInstanceTable.getCount
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1408

getElement

getElement(familyInstanceIndex: number): Promise<IElement>
Parameters
- familyInstanceIndex: number
Returns Promise<IElement>
Implementation of IFamilyInstanceTable.getElement
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1471

getElementIndex

getElementIndex(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getElementIndex
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1469

getFacingFlipped

getFacingFlipped(familyInstanceIndex: number): Promise<boolean>
Parameters
- familyInstanceIndex: number
Returns Promise<boolean>
Implementation of IFamilyInstanceTable.getFacingFlipped
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1411

getFacingOrientation_X

getFacingOrientation_X(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getFacingOrientation_X
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1413

getFacingOrientation_Y

getFacingOrientation_Y(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getFacingOrientation_Y
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1415

getFacingOrientation_Z

getFacingOrientation_Z(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getFacingOrientation_Z
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1417

getFamilyType

getFamilyType(familyInstanceIndex: number): Promise<IFamilyType>
Parameters
- familyInstanceIndex: number
Returns Promise<IFamilyType>
Implementation of IFamilyInstanceTable.getFamilyType
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1459

getFamilyTypeIndex

getFamilyTypeIndex(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getFamilyTypeIndex
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1457

getFromRoom

getFromRoom(familyInstanceIndex: number): Promise<IRoom>
Parameters
- familyInstanceIndex: number
Returns Promise<IRoom>
Implementation of IFamilyInstanceTable.getFromRoom
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1465

getFromRoomIndex

getFromRoomIndex(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getFromRoomIndex
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1463

getHandFlipped

getHandFlipped(familyInstanceIndex: number): Promise<boolean>
Parameters
- familyInstanceIndex: number
Returns Promise<boolean>
Implementation of IFamilyInstanceTable.getHandFlipped
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1419

getHandOrientation_X

getHandOrientation_X(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getHandOrientation_X
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1451

getHandOrientation_Y

getHandOrientation_Y(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getHandOrientation_Y
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1453

getHandOrientation_Z

getHandOrientation_Z(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getHandOrientation_Z
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1455

getHasModifiedGeometry

getHasModifiedGeometry(familyInstanceIndex: number): Promise<boolean>
Parameters
- familyInstanceIndex: number
Returns Promise<boolean>
Implementation of IFamilyInstanceTable.getHasModifiedGeometry
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1423

getHost

getHost(familyInstanceIndex: number): Promise<IElement>
Parameters
- familyInstanceIndex: number
Returns Promise<IElement>
Implementation of IFamilyInstanceTable.getHost
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1462

getHostIndex

getHostIndex(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getHostIndex
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1460

getMirrored

getMirrored(familyInstanceIndex: number): Promise<boolean>
Parameters
- familyInstanceIndex: number
Returns Promise<boolean>
Implementation of IFamilyInstanceTable.getMirrored
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1421

getScale

getScale(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getScale
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1425

getToRoom

getToRoom(familyInstanceIndex: number): Promise<IRoom>
Parameters
- familyInstanceIndex: number
Returns Promise<IRoom>
Implementation of IFamilyInstanceTable.getToRoom
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1468

getToRoomIndex

getToRoomIndex(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getToRoomIndex
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1466

getTranslation_X

getTranslation_X(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getTranslation_X
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1445

getTranslation_Y

getTranslation_Y(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getTranslation_Y
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1447

getTranslation_Z

getTranslation_Z(familyInstanceIndex: number): Promise<number>
Parameters
- familyInstanceIndex: number
Returns Promise<number>
Implementation of IFamilyInstanceTable.getTranslation_Z
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1449

`Static` createFromDocument

createFromDocument(document: VimDocument): Promise<IFamilyInstanceTable>
Parameters
- document: VimDocument
Returns Promise<IFamilyInstanceTable>
- Defined in node_modules/vim-format/dist/objectModel.d.ts:1407

Generated using TypeDoc