INewEntityArgs Interface Reference

Represents arguments for new entity construction. More...

Inheritance diagram for INewEntityArgs:

Properties
int	CategoryId [get, set]
	The entity category ID.
int	HostObjectId [get, set]
	The host object ID.
Placement3D	Placement3D [get, set]
	The 3D placement.
GUID	TypeId [get, set]
	The entity type ID.

Detailed Description

Represents arguments for new entity construction.

See also

IEntity, IEntityCollection::CreateNewEntityArgs, IModel::CreateNewEntityArgs

Property Documentation

CategoryId

int CategoryId

getset

The entity category ID.

The category ID of the entity to create. The property applies to entities that are based on categories (MEP styles). For example, to create Equipment style or Pipe fitting style, set CategoryID equal to one of the Equipment or Pipe fitting categories.

See also

IProject::ImportCategory

HostObjectId

int HostObjectId

getset

The host object ID.

The ID of the object that is the host for the object being created. For example: To create wall, set HostObjectId equal to one of the level IDs. To create window, set HostObjectId equal to one of the wall IDs.

• For objects on level:
  • If HostObjectId is set, HostObjectId must be equal to the level ID .
  • If HostObjectId is not set, then when created in a Building model, the object will be created by default on the current level, and when created in an Assembly model, the object will be created by default in the Assembly.
• For dependent objects (windows, doors, etc.):
  • If HostObjectId is set, HostObjectId must be equal to the ID of the object on which the object being created and which can host such objects.
  • If HostObjectId is not set, the object will not be created.

Placement3D

Placement3D Placement3D

getset

The 3D placement.

The global 3D placement of the object being created. The property applies to level based objects. By default, Placement3D is equal to right orthonormalized coordinate system, that is it`s equal to Placement3D{ .origin = (0, 0, 0), .xAxis = (1, 0, 0), .zAxis = (0, 0, 1) }

• For dependent objects:
  • The X-Axis direction of the placement determines the direction of the outer side of the Window/Door relative to the host object.
  • If X-axis vector of the placement is co-directed with the center line vector of the host object, the outer side of Window/Door directed in the same direction as the outer side of the host object, if they are counter-directed - the outer side of Window/Door directed in the same direction as the inner side of the host object.
  Explanation of Window/Door placement using the X-axis:

• The placement of the created object may differ from the specified one.

TypeId

GUID TypeId

getset

The entity type ID.

The type id of the the entity to create. For example, to create Material, set TypeID equal to StyleTypeIds::Material.

See also

Style types.