formZ SDK | 4.0 Call Back Reference | Object Type

fz_otyp_cbak_geom

Description

Object type geometry function (Optional). This function is called to retrieve basic geometric information about the object. It should be implemented if the object has its own coordinate . For example, a sphere has its own x, y and z axis, which describe the location and orientation of the sphere in 3d space. The plane parameter returns the origin and rotation of the object's coordinate in world space. This information is used, for example, to draw the object axes in Wire Frame. The center parameter returns the object's origin in the coordinate space of the object. Usually the center would be set to {0.0, 0.0, 0.0}, but may have different values, depending on the nature of the object. The bbox parameter returns the extent of the object along its x, y and z axis.

Plugin Prototype

fzrt_error_td fz_otyp_cbak_geom(

fzrt_int

windex,

fz_objt_ptr

obj,

fzrt_ptr

parm,

fz_map_plane_td *

plane,

fz_xyz_td *

center,

fz_xyz_mm_td *

bbox )

Parameters

windex [Input]

project window index

obj [Input]

object

parm [Input]

generic pointer to the parameter block

plane [Result, Optional]

3d mapping plane. This defines the origin and rotation of the object

center [Result, Optional]

A point identifying the origin of the object, expressed in the coordinate of the object.

bbox [Result, Optional]

A 3d bounding box which encloses the object. The extent is measured along the axes of the object's coordinate .

Returns

Error codes

Availability

5.0.0.0

Function Set

fz_otyp_cbak_fset


Defined in

fz_otyp_api.h