BuildingGrid#

Attribute Name

Data Type

Description

no

int

Object number

type

BuildingGridType

Building grid type

user_defined_name_enabled

bool

User-defined name enabled

name

str

Name

grid_type

BuildingGridGridType

Grid type

locked_in_graphics

bool

Locked in graphics

include_in_view

bool

Include in view ‘Show whole model’

grid_points

bool

Grid points

grid_lines

bool

Grid lines

labels

bool

Labels

dimensions

bool

Dimensions

is_origin_defined_by_node

bool

Origin defined by node

origin_node

int

Node

origin_coordinate_x

float

Origin coordinates Origin coordinates | X_0

origin_coordinate_y

float

Origin coordinates | Y_0

origin_coordinate_z

float

Origin coordinates | Z_0

alpha_ux

float

Inclination angles | α_X

alpha_vy

float

Inclination angles | α_Y

alpha_wz

float

Inclination angles | α_Z

coordinate_system

int

Coordinate system

rotation_coordinate_system

int

Coordinate system

has_specific_direction

bool

Has specific direction

specific_direction_type

BuildingGridSpecificDirectionType

Specific Direction Type

axes_sequence

BuildingGridAxesSequence

Sequence

rotated_about_angle_x

float

Rotation angle about X axis | α_’

rotated_about_angle_y

float

Rotation angle about Y axis | α_’

rotated_about_angle_z

float

Rotation angle about Z axis | α_’

rotated_about_angle_1

float

Rotation angle about first axis | α_1

rotated_about_angle_2

float

Rotation angle about second axis | α_2

rotated_about_angle_3

float

Rotation angle about third axis | α_3

directed_to_node_direction_node

int

Direct to node No.

directed_to_node_plane_node

int

In plane by node No.

directed_to_node_first_axis

BuildingGridDirectedToNodeFirstAxis

1st axis

directed_to_node_second_axis

BuildingGridDirectedToNodeSecondAxis

2nd axis

parallel_to_two_nodes_first_node

int

First node

parallel_to_two_nodes_second_node

int

Second node

parallel_to_two_nodes_plane_node

int

In plane by node No.

parallel_to_two_nodes_first_axis

BuildingGridParallelToTwoNodesFirstAxis

1st axis

parallel_to_two_nodes_second_axis

BuildingGridParallelToTwoNodesSecondAxis

2nd axis

parallel_to_line

int

Line No.

parallel_to_member

int

Member No.

comment

str

Comment

coordinates_list_x

str

List of coordinates | X

coordinates_list_y

str

List of coordinates | Y

coordinates_list_z

str

List of coordinates | Z

labels_list_x

str

List of labels | X

labels_list_y

str

List of labels | Y

labels_list_z

str

List of labels | Z

line_end_extension_x

float

Extension at line end | e_X,j

line_end_extension_y

float

Extension at line end | e_Y,j

line_end_extension_z

float

Extension at line end | e_Z,j

line_end_label_x

bool

Show label at line end

line_end_label_y

bool

Show label at line end

line_end_label_z

bool

Show label at line end

line_start_extension_x

float

Extension at line start | e_X,i

line_start_extension_y

float

Extension at line start | e_Y,i

line_start_extension_z

float

Extension at line start | e_Z,i

line_start_label_x

bool

Show label at line start

line_start_label_y

bool

Show label at line start

line_start_label_z

bool

Show label at line start

id_for_export_import

str

metadata_for_export_import

str

Associated Enums#

BuildingGridType#

Name

BUILDING_GRID_TYPE_UNKNOWN

BUILDING_GRID_TYPE_STANDARD

BuildingGridGridType#

Name

BUILDING_GRID_GRID_TYPE_CARTESIAN

BUILDING_GRID_GRID_TYPE_CYLINDRICAL

BUILDING_GRID_GRID_TYPE_INCLINED

BUILDING_GRID_GRID_TYPE_SPHERICAL

BuildingGridSpecificDirectionType#

Name

BUILDING_GRID_SPECIFIC_DIRECTION_TYPE_ROTATED_VIA_3_ANGLES

BUILDING_GRID_SPECIFIC_DIRECTION_TYPE_DIRECTED_TO_NODE

BUILDING_GRID_SPECIFIC_DIRECTION_TYPE_PARALLEL_TO_CS_OF_LINE

BUILDING_GRID_SPECIFIC_DIRECTION_TYPE_PARALLEL_TO_CS_OF_MEMBER

BUILDING_GRID_SPECIFIC_DIRECTION_TYPE_PARALLEL_TO_TWO_NODES

BuildingGridAxesSequence#

Name

BUILDING_GRID_AXES_SEQUENCE_XYZ

BUILDING_GRID_AXES_SEQUENCE_XZY

BUILDING_GRID_AXES_SEQUENCE_YXZ

BUILDING_GRID_AXES_SEQUENCE_YZX

BUILDING_GRID_AXES_SEQUENCE_ZXY

BUILDING_GRID_AXES_SEQUENCE_ZYX

BuildingGridDirectedToNodeFirstAxis#

Name

BUILDING_GRID_DIRECTED_TO_NODE_FIRST_AXIS_X

BUILDING_GRID_DIRECTED_TO_NODE_FIRST_AXIS_Y

BUILDING_GRID_DIRECTED_TO_NODE_FIRST_AXIS_Z

BuildingGridDirectedToNodeSecondAxis#

Name

BUILDING_GRID_DIRECTED_TO_NODE_SECOND_AXIS_X

BUILDING_GRID_DIRECTED_TO_NODE_SECOND_AXIS_Y

BUILDING_GRID_DIRECTED_TO_NODE_SECOND_AXIS_Z

BuildingGridParallelToTwoNodesFirstAxis#

Name

BUILDING_GRID_PARALLEL_TO_TWO_NODES_FIRST_AXIS_X

BUILDING_GRID_PARALLEL_TO_TWO_NODES_FIRST_AXIS_Y

BUILDING_GRID_PARALLEL_TO_TWO_NODES_FIRST_AXIS_Z

BuildingGridParallelToTwoNodesSecondAxis#

Name

BUILDING_GRID_PARALLEL_TO_TWO_NODES_SECOND_AXIS_X

BUILDING_GRID_PARALLEL_TO_TWO_NODES_SECOND_AXIS_Y

BUILDING_GRID_PARALLEL_TO_TWO_NODES_SECOND_AXIS_Z