INewEntityArgs Interface Reference

Represents arguments for new entity construction. More...

Properties
int	CategoryId [get, set]
	The entity category ID.
BSTR	FilePath [get, set]
	The path to the file.
int	HostObjectId [get, set]
	The host object ID.
Placement2D	Placement2D [get, set]
	The 2D placement.
Placement3D	Placement3D [get, set]
	The 3D placement.
int	StyleId [get, set]
	The style ID.
GUID	TypeId [get, set]
	The entity type ID.
BSTR	TypeIdS [get, set]
	Same as TypeId, but accepting and returning GUID as a string.

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. This property applies to create 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

FilePath

BSTR FilePath

getset

The path to the file.

The path to the file with wich the linked object should be created.

Note

The path must be specified in absolute adress space, for example: D:\image.png

Supported formats:

• For LinkedImage and DrawingLinkedImage, the supported formats are .PNG and .JPG.

• For LinkedDrawing and DrawingLinkedDrawing, the supported formats are .DXF and .DWG.

• For LinkedModel, all 3D formats available under your Renga license are supported.

HostObjectId

int HostObjectId

getset

The host object ID.

The ID of the object that is the host for the object being created.

This property applies to create level based objects, see ILevelObject.

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.

Placement2D

Placement2D Placement2D

getset

The 2D placement.

The global 2D placement of the object being created.

Note

This property applies to create 2D placement based objects, see IPlacement2DObject. To create level based objects use INewEntityArgs::Placement3D property

By default, Placement2D is equal to right orthonormalized coordinate system, that is it`s equal to Placement2D{ .origin = (0, 0), .xAxis = (1, 0) }

Placement3D

Placement3D Placement3D

getset

The 3D placement.

The global 3D placement of the object being created.

Note

This property applies to create level based objects, see ILevelObject. To create 2D placement based objects use INewEntityArgs::Placement2D property

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 Origin of the placement determines which face of the host object is selected to create the Hole - the closest face to Origin is selected. The Hole will be created on the face in the projection of the Origin.
    Explanation of Hole placement using Origin:
    
    
  • The placement of the created object may differ from the specified one.

StyleId

int StyleId

getset

The style ID.

This property applies to set a style for stylable objects.

Note

A style must be assigned before creating Equipment, MechanicalEquipment and PlumbingFixture objects.

The "none" style can be set by assigning the value 0 to StyleId. The "none" style is applicable only to Door and Window.

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 Renga::EntityTypes::Material.

See also

Entity types.