IModel Interface Reference

Allows to obtain and edit model objects. More...

Public Member Functions
HRESULT	CreateNewEntityArgs ([out, retval] INewEntityArgs **ppArgs)
	Creates arguments for creating a new entity.
HRESULT	CreateObject ([in] INewEntityArgs *pArgs, [out, retval] IModelObject **ppModelObject)
	Creates a new model object.
HRESULT	CreateOperation ([out, retval] IOperation **ppOperation)
	Creates an operation.
HRESULT	DeleteObjectById ([in] int id_)
	Deletes a model object by its local identifier.
HRESULT	DeleteObjectByUniqueId ([in] GUID uniqueId_)
	Deletes a model object by its unique identifier.
HRESULT	DeleteObjectByUniqueIdS ([in] BSTR uniqueId_)
	Same as DeleteObjectByUniqueId, but accepting GUID as a string.
HRESULT	GetBoundingBox ([out, retval] Cube *pCube)
	Returns the axis-aligned bounding box of the model.
HRESULT	GetIdFromUniqueId ([in] GUID uniqueId_, [out, retval] int *id_)
	Returns the local identifier of the object of this model by it's unique identifier.
HRESULT	GetIdFromUniqueIdS ([in] BSTR uniqueId_, [out, retval] int *id_)
	Same as GetIdFromUniqueId, but accepting GUID as a string.
HRESULT	GetObjects ([out, retval] IModelObjectCollection **ppModelObjectCollection)
	Returns a collection of all objects present in the model.
HRESULT	GetUniqueIdFromId ([in] int id_, [out, retval] GUID *uniqueId_)
	Returns the unique identifier of the object of this model by it's local identifier.
HRESULT	GetUniqueIdFromIdS ([in] int id_, [out, retval] BSTR *uniqueId_)
	Same as GetUniqueIdFromId, but returning GUID as a string.

Properties
GUID	Id [get]
	The identifier of the model.

Detailed Description

Allows to obtain and edit model objects.

This interface can be obtained with IProject::Model (building model) property. It also can be obtained
as an additional interface from IEntity if the entity is an Assembly (IProject::Assemblies) or a Drawing (IProject::Drawings2).

Member Function Documentation

CreateNewEntityArgs()

HRESULT CreateNewEntityArgs

(

[out, retval] INewEntityArgs **

ppArgs

)

Creates arguments for creating a new entity.

Parameters

[out]

ppArgs

The arguments for creating a new entity.

See also

INewEntityArgs

CreateObject()

HRESULT CreateObject	(	[in] INewEntityArgs *	pArgs,
		[out, retval] IModelObject **	ppModelObject )

Creates a new model object.

Parameters

[in]	pArgs	Arguments for creating a model object.
[out]	ppModelObject	The created model object instance.

A table of matching types of objects that can be created and models in which they can be created:

Object type	Building model	Assembly model	Drawing model
AssemblyInstance	+	+	-
Beam	+	+	-
Column	+	+	-
Door	+	+	-
DrawingImage	-	-	+
DrawingReferenceDrawing	-	-	+
DrawingText	-	-	+
Element	+	+	-
Equipment	+	-	-
Floor	+	+	-
Hatch	+	-	-
Hole	+	+	-
Image	+	+	-
IsolatedFoundation	+	+	-
Level	+	-	-
Line3D	+	+	-
MechanicalEquipment	+	-	-
Model3D	+	+	-
ModelText	+	-	-
Opening	+	+	-
Plate	+	+	-
PlumbingFixture	+	-	-
Railing	+	+	-
Ramp	+	+	-
ReferenceDrawing	+	+	-
Roof	+	-	-
Room	+	-	-
Stair	+	+	-
Wall	+	+	-
WallFoundation	+	+	-
Window	+	+	-

For dependent objects:

• When creating a Window / Door, its location relative to the host is determined by the Origin and the X-axis of its placement. See INewEntityArgs::Placement3D.
• When creating a Hole, its location relative to the host is determined by the Origin of its placement. See INewEntityArgs::Placement3D.
• When creating an Opening, it is created according to the specified placement.

Note

When creating Equipment, MechanicalEquipment or a PlumbingFixture, you must specify style id in INewEntityArgs::StyleId.

When creating a Image, a Model3D, a ReferenceDrawing, a DrawingReferenceDrawing, or a DrawingImage, you must specify the file path in INewEntityArgs::FilePath.

Returns

The created model object instance.

See also

Entity types

CreateOperation()

HRESULT CreateOperation

(

[out, retval] IOperation **

ppOperation

)

Creates an operation.

To modify any model object you need to create an operation and start it before the modifications are done, and apply it afterwards.

Deprecated

This method is deprecated, use IProject::CreateOperation instead

Returns

The newly created operation.

DeleteObjectById()

HRESULT DeleteObjectById

(

[in] int

id_

)

Deletes a model object by its local identifier.

Parameters

[in]

id_

Local identifier of the object being deleted.

See also

DeleteObjectByUniqueId

DeleteObjectByUniqueId()

HRESULT DeleteObjectByUniqueId

(

[in] GUID

uniqueId_

)

Deletes a model object by its unique identifier.

Parameters

[in]

uniqueId_

Unique identifier of the object being deleted.

See also

DeleteObjectById

DeleteObjectByUniqueIdS()

HRESULT DeleteObjectByUniqueIdS

(

[in] BSTR

uniqueId_

)

Same as DeleteObjectByUniqueId, but accepting GUID as a string.

Parameters

[in]

uniqueId_

Unique identifier of the object being deleted as a string.

See also

DeleteObjectByUniqueId

GetBoundingBox()

HRESULT GetBoundingBox

(

[out, retval] Cube *

pCube

)

Returns the axis-aligned bounding box of the model.

For a drawing model, returns a bounding box with dimensions corresponding to the drawing's page size and a Z-coordinate of zero.

For assembly and building models, returns the bounding box of all physical geometry in the model, aligned with the Global Coordinate System axes.

For an empty assembly and building models, the function returns a bounding box with zero dimensions.

GetObjects()

HRESULT GetObjects

(

[out, retval] IModelObjectCollection **

ppModelObjectCollection

)

Returns a collection of all objects present in the model.

Returns

Collection of model objects.