Functions | |
StatusInt | mdlModelRef_getRange (DgnModelRefP modelRef, DRange3dP pRange, int viewIndex, TransformP transformP, bool includeChildren) |
Gets the range for the specified modelRef. More... | |
DgnPlatform::ModelId | mdlModelRef_getModelID (DgnModelRefP modelRef) |
Gets the DgnPlatform::ModelId of a model. More... | |
StatusInt | mdlModelRef_getModelName (DgnModelRefP modelRef, WCharP nameP) |
Gets the name of a model. More... | |
StatusInt | mdlModelRef_setModelName (DgnModelRefP modelRef, const WChar *nameP) |
Sets the name of a model. More... | |
StatusInt | mdlModelRef_getModelDescription (DgnModelRefP modelRef, WChar *pDescr) |
Gets the description of a model. More... | |
StatusInt | mdlModelRef_setModelDescription (DgnModelRefP modelRef, const WChar *pDefaultRefLogical) |
Sets the default reference logical name for a model. More... | |
StatusInt | mdlModelRef_setModelDefaultRefLogical (DgnModelRefP modelRef, const WChar *pDescr) |
Sets the description of a model. More... | |
StatusInt | mdlModelRef_setModelType (DgnModelRefP modelRef, DgnPlatform::DgnModelType type) |
Sets the type of a model. More... | |
StatusInt | mdlModelRef_setModelFlag (DgnModelRefP modelRef, int flagNum, int value) |
Sets various flags of a model. More... | |
double | mdlModelRef_getUorPerMaster (DgnModelRefP modelRef) |
Gets the number of uors per master unit for a model. More... | |
double | mdlModelRef_getUorPerSub (DgnModelRefP modelRef) |
Gets the number of uors per sub unit for a model. More... | |
double | mdlModelRef_getSubPerMaster (DgnModelRefP modelRef) |
Gets the number of sub units per master unit for a model. More... | |
double | mdlModelRef_getUorPerStorage (DgnModelRefP modelRef) |
Gets the number of uors per storage unit for a model. More... | |
double | mdlModelRef_getUorPerMeter (DgnModelRefP modelRef) |
Gets the number of UORs per meter for a given model ref. More... | |
StatusInt | mdlModelRef_getMasterUnit (DgnModelRefP modelRef, DgnPlatform::UnitInfo *pUnitInfo) |
Gets the master unit definition of a model. More... | |
StatusInt | mdlModelRef_getSubUnit (DgnModelRefP modelRef, DgnPlatform::UnitInfo *pUnitInfo) |
Gets the sub unit definition of a model. More... | |
StatusInt | mdlModelRef_getSubUnitLabel (DgnModelRefP modelRef, WCharP pLabel) |
Gets the sub unit label of a model. More... | |
StatusInt | mdlModelRef_getMasterUnitLabel (DgnModelRefP modelRef, WCharP pLabel) |
Gets the master unit label of a model. More... | |
StatusInt | mdlModelRef_getStorageUnit (DgnModelRefP modelRef, DgnPlatform::UnitInfo *pUnitInfo) |
Gets the storage unit definition of a model. More... | |
StatusInt | mdlModelRef_setWorkingUnits (DgnModelRefP modelRef, const DgnPlatform::UnitInfo *pNewMasterUnit, const DgnPlatform::UnitInfo *pNewSubUnit) |
Sets the working units of a model, including the definition for both the master and the sub unit. More... | |
StatusInt | mdlModelRef_setStorageUnits (DgnModelRefP modelRef, const DgnPlatform::UnitInfo *pNewStorageUnit, double *pNewUorPerStorage) |
Sets the storage unit definition of a model. More... | |
StatusInt | mdlModelRef_setMasterUnitLabel (DgnModelRefP modelRef, const WChar *pLabel) |
Sets the master unit label of a model. More... | |
StatusInt | mdlModelRef_setSubUnitLabel (DgnModelRefP modelRef, WCharCP pLabel) |
Sets the sub unit label of a model. More... | |
StatusInt | mdlModelRef_getGlobalOrigin (DgnModelRefP modelRef, DPoint3dP pGlobalOrigin) |
Gets the global origin of a model. More... | |
StatusInt | mdlModelRef_setGlobalOrigin (DgnModelRefP modelRef, DPoint3dCP pGlobalOrigin) |
Sets the global origin of a model. More... | |
StatusInt | mdlModelRef_getAzimuth (DgnModelRefP modelRef, double *pAzimuth) |
Gets the azimuthal angle (the angle between the Y axis and true north) of the model in degrees. More... | |
StatusInt | mdlModelRef_setAzimuth (DgnModelRefP modelRef, double azimuth) |
Sets the azimuthal angle (the angle between the Y axis and true north) of the model in degrees. More... | |
StatusInt | mdlModelRef_getAuxCoordinateSystem (DgnModelRefP modelRef, Dpoint3d *pOrigin, RotMatrixP pRotMatrix, DgnPlatform::ACSType *pType, DgnPlatform::ElementId *pElementId) |
Gets the definition of the active auxiliary coordinate system of a model. More... | |
StatusInt | mdlModelRef_getAuxCoordinateSystem2 (DgnModelRefP modelRef, Dpoint3d *pOrigin, RotMatrixP pRotMatrix, double *pScale, DgnPlatform::ACSType *pType, DgnPlatform::ElementId *pElementId) |
Get the active ACS for a model. More... | |
StatusInt | mdlModelRef_setAuxCoordinateSystem (DgnModelRefP modelRef, const Dpoint3d *pOrigin, RotMatrixCP pRotMatrix, const DgnPlatform::ACSType *pType, const DgnPlatform::ElementId *pElementId) |
Sets the definition of the active auxiliary coordinate system of a model. More... | |
StatusInt | mdlModelRef_setAuxCoordinateSystem2 (DgnModelRefP modelRef, const Dpoint3d *pOrigin, RotMatrixCP pRotMatrix, const double *pScale, const DgnPlatform::ACSType *pType, const DgnPlatform::ElementId *pElementId) |
Set the active ACS for a model. More... | |
StatusInt | mdlModelRef_setGridParams (DgnModelRefP modelRef, const double *pUorPerGrid, const UInt32 *pGridPerRefernce, const double *pGridRatio, const DPoint2d *pGridBase, const double *pGridAngle) |
Sets the grid parameters of a model. More... | |
StatusInt | mdlModelRef_setRoundoffUnit (DgnModelRefP modelRef, const double *pRoundoffUnit, const double *pRoundOffRatio) |
Sets the roundoff unit of a model. More... | |
bool | mdlModel_nameCharIsValid (const WChar modelNameChar) |
Tests if the supplied character is valid for a model name. More... | |
bool | mdlModel_nameIsValid (const WChar *modelName) |
Tests if the supplied string is a valid model name. More... | |
StatusInt | mdlModelRef_setCellType (DgnModelRefP modelRef, DgnPlatform::CellLibraryType cellType) |
Set the cell type of a model. More... | |
StatusInt | mdlModelRef_setSheetDef (DgnModelRefP modelRefIn, SheetDefCP sheetDefIn) |
For a modelref, set its sheet definition. More... | |
StatusInt | mdlSheetDef_initialize (SheetDefP sheetDefIn) |
Initialize new sheet definition structure. More... | |
SheetDefP | mdlSheetDef_new () |
Allocate a new sheet definition structure. More... | |
StatusInt | mdlSheetDef_free (SheetDefP *sheetDef) |
Free a sheet definition structure. More... | |
StatusInt | mdlSheetDef_copy (SheetDefP destSheetDefOut, SheetDefCP sourceSheetDefIn) |
Copy sheet defintion information from source to destination. More... | |
bool | mdlSheetDef_compareData (BitMaskP compareBitMaskOut, SheetDefCP sheetDef1In, SheetDefCP sheetDef2In, BitMaskCP compareAttributesMaskIn) |
Compare if sheet related data between two sheet defs. More... | |
bool | mdlSheetDef_isEnabled (SheetDefCP sheetDefIn) |
For a sheet definition, check if the sheet related information is enabled. More... | |
StatusInt | mdlSheetDef_enable (SheetDefP sheetDefIn, bool isEnabledIn) |
For a sheet definition, set if the sheet related information is to be enabled. More... | |
StatusInt | mdlSheetDef_getOrigin (SheetDefCP sheetDefIn, DPoint2d *sheetOriginOut) |
For a sheet definition, get origin - the lower left hand corner of the sheet relative to the sheet model's origin. More... | |
StatusInt | mdlSheetDef_setOrigin (SheetDefP sheetDefIn, DPoint2d const *sheetOriginIn) |
For a sheet definition, set its origin - the lower left hand corner of the sheet relative to the sheet model's origin. More... | |
StatusInt | mdlSheetDef_getRotation (SheetDefCP sheetDefIn, double *sheetRotationOut) |
For a sheet definition, get rotation - relative to the X axis of the sheet model in the XY plane. More... | |
StatusInt | mdlSheetDef_setRotation (SheetDefP sheetDefIn, double sheetRotationIn) |
For a sheet definition, set rotation - relative to the X axis of the sheet model in the XY plane. More... | |
StatusInt | mdlSheetDef_getSize (SheetDefCP sheetDefIn, double *sheetWidthOut, double *sheetHeightOut) |
For a sheet definition, get sheet size. More... | |
StatusInt | mdlSheetDef_setSize (SheetDefP sheetDefIn, double sheetWidthIn, double sheetHeightIn) |
For a sheet definition, set size. More... | |
StatusInt | mdlSheetDef_getFormName (SheetDefCP sheetDefIn, WStringR formNameOut) |
For a sheet definition, get its form name - this is a name associated with its size. More... | |
StatusInt | mdlSheetDef_setFormName (SheetDefP sheetDefIn, WChar const *formNameIn) |
For a sheet definition, set its form name - this is a name associated with its size. More... | |
StatusInt | mdlSheetDef_getColor (SheetDefCP sheetDefIn, UInt32 *sheetColorOut) |
For a sheet definition, get color. More... | |
StatusInt | mdlSheetDef_setColor (SheetDefP sheetDefIn, UInt32 sheetColorIn) |
For a sheet definition, set color. More... | |
StatusInt | mdlSheetDef_getUnits (SheetDefCP sheetDefIn, DgnPlatform::UnitInfo *unitInfoOut) |
For a sheet definition, get its units. More... | |
StatusInt | mdlSheetDef_setUnits (SheetDefP sheetDefIn, DgnPlatform::UnitInfo const *unitInfoIn) |
For a sheet definition, set its units. More... | |
StatusInt | mdlSheetDef_getPaperMargins (SheetDefCP sheetDefIn, double *topMarginOut, double *leftMarginOut, double *bottomMarginOut, double *rightMarginOut) |
For a sheet definition, get its margins. More... | |
StatusInt | mdlSheetDef_setPaperMargins (SheetDefP sheetDefIn, double topMarginIn, double leftMarginIn, double bottomMarginIn, double rightMarginIn) |
For a sheet definition, set its margins. More... | |
StatusInt | mdlSheetDef_getPlotStyleTableFileName (SheetDefCP sheetDefIn, WStringR pstFileNameOut) |
For a sheet definition, get the plot style table file name. More... | |
StatusInt | mdlSheetDef_setPlotStyleTableFileName (SheetDefP sheetDefIn, WChar const *pstFileNameIn) |
For a sheet definition, set the plot style table file name. More... | |
StatusInt | mdlSheetDef_getPrintStyleName (SheetDefCP sheetDefIn, WStringR printStyleNameOut) |
For a sheet definition, get the print style name. More... | |
StatusInt | mdlSheetDef_setPrintStyleName (SheetDefP sheetDefIn, WChar const *printStyleNameIn) |
For a sheet definition, set the print style name. More... | |
StatusInt | mdlSheetDef_getSheetNumber (SheetDefCP sheetDefIn, UInt32 *sheetNumberOut) |
For a sheet definition, get the sheet number. More... | |
StatusInt | mdlSheetDef_setSheetNumber (SheetDefP sheetDefIn, UInt32 sheetNumberIn) |
For a sheet definition, set sheet number. More... | |
StatusInt | mdlSheetDef_getBorderAttachmentId (SheetDefCP sheetDefIn, UInt64 *borderAttachmentIdOut) |
For a sheet definition, get its border attachment id (if any). More... | |
StatusInt | mdlSheetDef_setBorderAttachmentId (SheetDefP sheetDefIn, UInt64 borderAttachmentIdIn) |
For a sheet definition, set its border attachment id. More... | |
bool mdlModel_nameCharIsValid | ( | const WChar | modelNameChar | ) |
Tests if the supplied character is valid for a model name.
[in] | modelNameChar | the character to test. |
bool mdlModel_nameIsValid | ( | const WChar * | modelName | ) |
Tests if the supplied string is a valid model name.
The test includes checking each character and also checking for all spaces.
[in] | modelName | the name to test. |
StatusInt mdlModelRef_getAuxCoordinateSystem | ( | DgnModelRefP | modelRef, |
Dpoint3d * | pOrigin, | ||
RotMatrixP | pRotMatrix, | ||
DgnPlatform::ACSType * | pType, | ||
DgnPlatform::ElementId * | pElementId | ||
) |
Gets the definition of the active auxiliary coordinate system of a model.
[in] | modelRef | get the property of the model referenced by this. |
[out] | pOrigin | origin of the acs. |
[out] | pRotMatrix | rotation of the acs. |
[out] | pType | type of the acs, ex. ACS_TYPE_RECT. |
[out] | pElementId | if a named acs is active the id of the element, else 0 |
StatusInt mdlModelRef_getAuxCoordinateSystem2 | ( | DgnModelRefP | modelRef, |
Dpoint3d * | pOrigin, | ||
RotMatrixP | pRotMatrix, | ||
double * | pScale, | ||
DgnPlatform::ACSType * | pType, | ||
DgnPlatform::ElementId * | pElementId | ||
) |
Get the active ACS for a model.
[in] | modelRef | modelRef |
[out] | pOrigin | origin of aux coord sys |
[out] | pRotMatrix | rotation of aux coord sys |
[out] | pScale | scale of aux coord sys |
[out] | pType | type of aux coord sys ex. ACS_TYPE_RECT |
[out] | pElementId | id of named acs element (if any) |
StatusInt mdlModelRef_getAzimuth | ( | DgnModelRefP | modelRef, |
double * | pAzimuth | ||
) |
Gets the azimuthal angle (the angle between the Y axis and true north) of the model in degrees.
[in] | modelRef | get the property of the model referenced by this. |
[out] | pAzimuth | the azimuth location - in degrees. |
StatusInt mdlModelRef_getGlobalOrigin | ( | DgnModelRefP | modelRef, |
DPoint3dP | pGlobalOrigin | ||
) |
Gets the global origin of a model.
[in] | modelRef | get the property of the model referenced by this. |
[out] | pGlobalOrigin | the global origin location - in UORs. |
StatusInt mdlModelRef_getMasterUnit | ( | DgnModelRefP | modelRef, |
DgnPlatform::UnitInfo * | pUnitInfo | ||
) |
Gets the master unit definition of a model.
[in] | modelRef | the model to get the master unit definition from. |
[out] | pUnitInfo | the master unit definition |
StatusInt mdlModelRef_getMasterUnitLabel | ( | DgnModelRefP | modelRef, |
WCharP | pLabel | ||
) |
Gets the master unit label of a model.
[in] | modelRef | get the property of the model referenced by this. |
[out] | pLabel | the master unit label string |
StatusInt mdlModelRef_getModelDescription | ( | DgnModelRefP | modelRef, |
WChar * | pDescr | ||
) |
Gets the description of a model.
[in] | modelRef | get the property of the model referenced by this. |
[out] | pDescr | the description string for the model. |
DgnPlatform::ModelId mdlModelRef_getModelID | ( | DgnModelRefP | modelRef | ) |
Gets the DgnPlatform::ModelId of a model.
[in] | modelRef | get the property of the model referenced by this. |
StatusInt mdlModelRef_getModelName | ( | DgnModelRefP | modelRef, |
WCharP | nameP | ||
) |
Gets the name of a model.
[in] | modelRef | get the property of the model referenced by this. |
[out] | nameP | the name of the model |
StatusInt mdlModelRef_getRange | ( | DgnModelRefP | modelRef, |
DRange3dP | pRange, | ||
int | viewIndex, | ||
TransformP | transformP, | ||
bool | includeChildren | ||
) |
Gets the range for the specified modelRef.
This calculates the range for all geometry in a model - it does not ignore elements that are not displayed in the input view. This function is relatively fast. It does not iterate through the model but uses a range that is stored internally.
[in] | modelRef | the model to get the range for. |
[out] | pRange | the model range |
[in] | viewIndex | index of view, used to get the clip volume of the view. |
[in] | transformP | NULL or transform to apply before calculating range. |
[in] | includeChildren | true to include the range of child references. |
StatusInt mdlModelRef_getStorageUnit | ( | DgnModelRefP | modelRef, |
DgnPlatform::UnitInfo * | pUnitInfo | ||
) |
Gets the storage unit definition of a model.
[in] | modelRef | get the property of the model referenced by this. |
[out] | pUnitInfo | is the definition of the storage unit. |
double mdlModelRef_getSubPerMaster | ( | DgnModelRefP | modelRef | ) |
Gets the number of sub units per master unit for a model.
[in] | modelRef | get the property of the model referenced by this. |
StatusInt mdlModelRef_getSubUnit | ( | DgnModelRefP | modelRef, |
DgnPlatform::UnitInfo * | pUnitInfo | ||
) |
Gets the sub unit definition of a model.
[in] | modelRef | get the property of the model referenced by this. |
[out] | pUnitInfo | unit definition |
StatusInt mdlModelRef_getSubUnitLabel | ( | DgnModelRefP | modelRef, |
WCharP | pLabel | ||
) |
Gets the sub unit label of a model.
[in] | modelRef | get the property of the model referenced by this. |
[out] | pLabel | the sub unit label string. |
double mdlModelRef_getUorPerMaster | ( | DgnModelRefP | modelRef | ) |
Gets the number of uors per master unit for a model.
[in] | modelRef | get the property of the model referenced by this. |
double mdlModelRef_getUorPerMeter | ( | DgnModelRefP | modelRef | ) |
Gets the number of UORs per meter for a given model ref.
[in] | modelRef | get the property of the model referenced by this. |
double mdlModelRef_getUorPerStorage | ( | DgnModelRefP | modelRef | ) |
Gets the number of uors per storage unit for a model.
[in] | modelRef | get the property of the model referenced by this. |
double mdlModelRef_getUorPerSub | ( | DgnModelRefP | modelRef | ) |
Gets the number of uors per sub unit for a model.
[in] | modelRef | get the property of the model referenced by this. |
StatusInt mdlModelRef_setAuxCoordinateSystem | ( | DgnModelRefP | modelRef, |
const Dpoint3d * | pOrigin, | ||
RotMatrixCP | pRotMatrix, | ||
const DgnPlatform::ACSType * | pType, | ||
const DgnPlatform::ElementId * | pElementId | ||
) |
Sets the definition of the active auxiliary coordinate system of a model.
[in] | modelRef | set the property of the model referenced by this. |
[in] | pOrigin | origin of the acs, NULL for no change. |
[in] | pRotMatrix | rotation of the acs, NULL for no change. |
[in] | pType | type of the acs, ex. ACS_TYPE_RECT, NULL for no change. |
[in] | pElementId | id of named acs element, NULL sets id to 0 |
StatusInt mdlModelRef_setAuxCoordinateSystem2 | ( | DgnModelRefP | modelRef, |
const Dpoint3d * | pOrigin, | ||
RotMatrixCP | pRotMatrix, | ||
const double * | pScale, | ||
const DgnPlatform::ACSType * | pType, | ||
const DgnPlatform::ElementId * | pElementId | ||
) |
Set the active ACS for a model.
[in] | modelRef | modelRef |
[in] | pOrigin | origin of aux coord sys |
[in] | pRotMatrix | rotation of aux coord sys |
[in] | pScale | scale of aux coord sys |
[in] | pType | type of aux coord sys ex. ACS_TYPE_RECT |
[in] | pElementId | id of named acs element, NULL sets id to 0 |
StatusInt mdlModelRef_setAzimuth | ( | DgnModelRefP | modelRef, |
double | azimuth | ||
) |
Sets the azimuthal angle (the angle between the Y axis and true north) of the model in degrees.
[in] | modelRef | set the property of the model referenced by this. |
[in] | azimuth | the azimuthal angle (the angle between the Y axis and true north) in degrees. |
StatusInt mdlModelRef_setCellType | ( | DgnModelRefP | modelRef, |
DgnPlatform::CellLibraryType | cellType | ||
) |
Set the cell type of a model.
This is only used when the model is placed as a cell.
[in] | modelRef | Model to set data in. |
[in] | cellType | The cell type of the model. Possible values are CellLibraryTypes::Graphic, CellLibraryTypes::Point, defined in msdefs.h. |
StatusInt mdlModelRef_setGlobalOrigin | ( | DgnModelRefP | modelRef, |
DPoint3dCP | pGlobalOrigin | ||
) |
Sets the global origin of a model.
[in] | modelRef | set the property of the model referenced by this. |
[in] | pGlobalOrigin | the global origin to set - in UORs |
StatusInt mdlModelRef_setGridParams | ( | DgnModelRefP | modelRef, |
const double * | pUorPerGrid, | ||
const UInt32 * | pGridPerRefernce, | ||
const double * | pGridRatio, | ||
const DPoint2d * | pGridBase, | ||
const double * | pGridAngle | ||
) |
Sets the grid parameters of a model.
[in] | modelRef | set the property of the model referenced by this. |
[in] | pUorPerGrid | the number of uors per grid, NULL if not changing. |
[in] | pGridPerRefernce | the number of grids per ref grid, NULL if not changing. |
[in] | pGridRatio | the ratio of grid spacing y / x, NULL if not changing. |
[in] | pGridBase | grid base offset, NULL if not changing. |
[in] | pGridAngle | grid rotation angle, NULL if not changing. |
StatusInt mdlModelRef_setMasterUnitLabel | ( | DgnModelRefP | modelRef, |
const WChar * | pLabel | ||
) |
Sets the master unit label of a model.
[in] | modelRef | set the property of the model referenced by this. |
[in] | pLabel | the master unit label string to set. |
StatusInt mdlModelRef_setModelDefaultRefLogical | ( | DgnModelRefP | modelRef, |
const WChar * | pDescr | ||
) |
Sets the description of a model.
[in] | modelRef | set the property of the model referenced by this. |
[in] | pDescr | the default reference logical string to assign to the model. |
StatusInt mdlModelRef_setModelDescription | ( | DgnModelRefP | modelRef, |
const WChar * | pDefaultRefLogical | ||
) |
Sets the default reference logical name for a model.
[in] | modelRef | set the property of the model referenced by this. |
[in] | pDefaultRefLogical | the default reference logical name when this model is referenced. |
StatusInt mdlModelRef_setModelFlag | ( | DgnModelRefP | modelRef, |
int | flagNum, | ||
int | value | ||
) |
Sets various flags of a model.
Property flags will be saved to the model immediately, while settings flags will be saved the next time the settings are saved for this model. The flags are defined in mdl.h.
Properties Flags
MODELFLAG_NOT_IN_CELL_LIST Set the model so it does not appear in the cell list if this file is attached as a cell library.
MODELFLAG_NOT_IN_MODEL_LIST Set the model so it does not appear in the model list in the models dialog.
MODELFLAG_LSSCALE_IS_ANNSCALE
MODELFLAG_IS_ANNOTATION_CELL
Settings Flags
MODELFLAG_UNIT_LOCK
MODELFLAG_GRID_LOCK
MODELFLAG_ISO_GRID
MODELFLAG_ISO_LOCK
MODELFLAG_ISO_PLANE
MODELFLAG_USE_ANNOTATION_SCALE
MODELFLAG_ACS_LOCK
[in] | modelRef | set the property of the model referenced by this. |
[in] | flagNum | the flag to set the value of. |
[in] | value | the value to set, True or false for all except MODELFLAG_ISO_PLANE, which requires one of the IsoPlaneValues. |
StatusInt mdlModelRef_setModelName | ( | DgnModelRefP | modelRef, |
const WChar * | nameP | ||
) |
Sets the name of a model.
[in] | modelRef | set the property of the model referenced by this. |
[in] | nameP | the name to assign to the model. |
StatusInt mdlModelRef_setModelType | ( | DgnModelRefP | modelRef, |
DgnPlatform::DgnModelType | type | ||
) |
Sets the type of a model.
Valid Model Types
DgnModelType::Normal
DgnModelType::Sheet
[in] | modelRef | set the property of the model referenced by this. |
[in] | type | the type value for the model. Valid values are DgnModelType::Sheet and DgnModelType::Normal. |
StatusInt mdlModelRef_setRoundoffUnit | ( | DgnModelRefP | modelRef, |
const double * | pRoundoffUnit, | ||
const double * | pRoundOffRatio | ||
) |
Sets the roundoff unit of a model.
[in] | modelRef | set the property of the model referenced by this. |
[in] | pRoundoffUnit | the value of the roundoff unit. |
[in] | pRoundOffRatio | the ratio of round off units y / x (NULL to use grid ratio) |
StatusInt mdlModelRef_setSheetDef | ( | DgnModelRefP | modelRefIn, |
SheetDefCP | sheetDefIn | ||
) |
For a modelref, set its sheet definition.
[in] | modelRefIn | sheet model |
[in] | sheetDefIn | sheet definition |
StatusInt mdlModelRef_setStorageUnits | ( | DgnModelRefP | modelRef, |
const DgnPlatform::UnitInfo * | pNewStorageUnit, | ||
double * | pNewUorPerStorage | ||
) |
Sets the storage unit definition of a model.
[in] | modelRef | set the property of the model referenced by this. |
[in] | pNewStorageUnit | the definition of the storage unit. Pass NULL for no change. |
[in] | pNewUorPerStorage | the number of positional units per storage unit. Pass NULL for no change. |
StatusInt mdlModelRef_setSubUnitLabel | ( | DgnModelRefP | modelRef, |
WCharCP | pLabel | ||
) |
Sets the sub unit label of a model.
[in] | modelRef | set the property of the model referenced by this. |
[in] | pLabel | the sub unit label string to set. |
StatusInt mdlModelRef_setWorkingUnits | ( | DgnModelRefP | modelRef, |
const DgnPlatform::UnitInfo * | pNewMasterUnit, | ||
const DgnPlatform::UnitInfo * | pNewSubUnit | ||
) |
Sets the working units of a model, including the definition for both the master and the sub unit.
The new master and sub units must have the same base as the model's storage unit.
[in] | modelRef | set the property of the model referenced by this. |
[in] | pNewMasterUnit | the master unit definition to set. |
[in] | pNewSubUnit | the sub unit definition to set |
bool mdlSheetDef_compareData | ( | BitMaskP | compareBitMaskOut, |
SheetDefCP | sheetDef1In, | ||
SheetDefCP | sheetDef2In, | ||
BitMaskCP | compareAttributesMaskIn | ||
) |
Compare if sheet related data between two sheet defs.
The function will compare only those attributes as specified in compareAttributesMaskIn If compareAttributesMaskIn is NULL, then all the attributes will be compared.
[out] | compareBitMaskOut | if non-null, then return a set of bits that represent the attributes that are not the same. |
[in] | sheetDef1In | sheet definition 1 |
[in] | sheetDef2In | sheet definition 2 |
[in] | compareAttributesMaskIn | mask of attributes to compare |
StatusInt mdlSheetDef_copy | ( | SheetDefP | destSheetDefOut, |
SheetDefCP | sourceSheetDefIn | ||
) |
Copy sheet defintion information from source to destination.
[out] | destSheetDefOut | destination sheet definition |
[in] | sourceSheetDefIn | source sheet definition |
StatusInt mdlSheetDef_enable | ( | SheetDefP | sheetDefIn, |
bool | isEnabledIn | ||
) |
For a sheet definition, set if the sheet related information is to be enabled.
[in] | sheetDefIn | sheet definition |
[in] | isEnabledIn | true if the sheet related information is to be enabled. |
StatusInt mdlSheetDef_free | ( | SheetDefP * | sheetDef | ) |
Free a sheet definition structure.
[in] | sheetDef | sheet def structure to free |
StatusInt mdlSheetDef_getBorderAttachmentId | ( | SheetDefCP | sheetDefIn, |
UInt64 * | borderAttachmentIdOut | ||
) |
For a sheet definition, get its border attachment id (if any).
[in] | sheetDefIn | sheet definition |
[out] | borderAttachmentIdOut | sheet border attachment id |
StatusInt mdlSheetDef_getColor | ( | SheetDefCP | sheetDefIn, |
UInt32 * | sheetColorOut | ||
) |
For a sheet definition, get color.
[in] | sheetDefIn | sheet definition |
[out] | sheetColorOut | sheet color |
StatusInt mdlSheetDef_getFormName | ( | SheetDefCP | sheetDefIn, |
WStringR | formNameOut | ||
) |
For a sheet definition, get its form name - this is a name associated with its size.
[in] | sheetDefIn | sheet definition |
[in] | formNameOut | sheet form name |
StatusInt mdlSheetDef_getOrigin | ( | SheetDefCP | sheetDefIn, |
DPoint2d * | sheetOriginOut | ||
) |
For a sheet definition, get origin - the lower left hand corner of the sheet relative to the sheet model's origin.
[in] | sheetDefIn | sheet definition |
[out] | sheetOriginOut | sheet origin |
StatusInt mdlSheetDef_getPaperMargins | ( | SheetDefCP | sheetDefIn, |
double * | topMarginOut, | ||
double * | leftMarginOut, | ||
double * | bottomMarginOut, | ||
double * | rightMarginOut | ||
) |
For a sheet definition, get its margins.
[in] | sheetDefIn | sheet definition |
[out] | topMarginOut | top paper margin |
[out] | leftMarginOut | left paper margin |
[out] | bottomMarginOut | bottom paper margin |
[out] | rightMarginOut | right paper margin |
StatusInt mdlSheetDef_getPlotStyleTableFileName | ( | SheetDefCP | sheetDefIn, |
WStringR | pstFileNameOut | ||
) |
For a sheet definition, get the plot style table file name.
[in] | sheetDefIn | sheet definition |
[out] | pstFileNameOut | plot style table file name string |
StatusInt mdlSheetDef_getPrintStyleName | ( | SheetDefCP | sheetDefIn, |
WStringR | printStyleNameOut | ||
) |
For a sheet definition, get the print style name.
[in] | sheetDefIn | sheet definition |
[out] | printStyleNameOut | print style name string |
StatusInt mdlSheetDef_getRotation | ( | SheetDefCP | sheetDefIn, |
double * | sheetRotationOut | ||
) |
For a sheet definition, get rotation - relative to the X axis of the sheet model in the XY plane.
[in] | sheetDefIn | sheet definition |
[out] | sheetRotationOut | sheet rotation in radians |
StatusInt mdlSheetDef_getSheetNumber | ( | SheetDefCP | sheetDefIn, |
UInt32 * | sheetNumberOut | ||
) |
For a sheet definition, get the sheet number.
[in] | sheetDefIn | sheet definition |
[out] | sheetNumberOut | sheet number |
StatusInt mdlSheetDef_getSize | ( | SheetDefCP | sheetDefIn, |
double * | sheetWidthOut, | ||
double * | sheetHeightOut | ||
) |
For a sheet definition, get sheet size.
[in] | sheetDefIn | sheet definition |
[out] | sheetWidthOut | sheet width |
[out] | sheetHeightOut | sheet height |
StatusInt mdlSheetDef_getUnits | ( | SheetDefCP | sheetDefIn, |
DgnPlatform::UnitInfo * | unitInfoOut | ||
) |
For a sheet definition, get its units.
[in] | sheetDefIn | sheet definition |
[out] | unitInfoOut | sheet units |
StatusInt mdlSheetDef_initialize | ( | SheetDefP | sheetDefIn | ) |
Initialize new sheet definition structure.
[in] | sheetDefIn | sheet def structure |
bool mdlSheetDef_isEnabled | ( | SheetDefCP | sheetDefIn | ) |
For a sheet definition, check if the sheet related information is enabled.
[in] | sheetDefIn | sheet definition |
SheetDefP mdlSheetDef_new | ( | ) |
Allocate a new sheet definition structure.
StatusInt mdlSheetDef_setBorderAttachmentId | ( | SheetDefP | sheetDefIn, |
UInt64 | borderAttachmentIdIn | ||
) |
For a sheet definition, set its border attachment id.
When a border attachment is associated a sheet definition, then the sheet definition is derived from the border attachment.
[in] | sheetDefIn | sheet definition |
[in] | borderAttachmentIdIn | sheet border attachment id |
StatusInt mdlSheetDef_setColor | ( | SheetDefP | sheetDefIn, |
UInt32 | sheetColorIn | ||
) |
For a sheet definition, set color.
[in] | sheetDefIn | sheet definition |
[in] | sheetColorIn | sheet color |
StatusInt mdlSheetDef_setFormName | ( | SheetDefP | sheetDefIn, |
WChar const * | formNameIn | ||
) |
For a sheet definition, set its form name - this is a name associated with its size.
[in] | sheetDefIn | sheet definition |
[in] | formNameIn | sheet form name |
StatusInt mdlSheetDef_setOrigin | ( | SheetDefP | sheetDefIn, |
DPoint2d const * | sheetOriginIn | ||
) |
For a sheet definition, set its origin - the lower left hand corner of the sheet relative to the sheet model's origin.
[in] | sheetDefIn | sheet definition |
[in] | sheetOriginIn | sheet origin |
StatusInt mdlSheetDef_setPaperMargins | ( | SheetDefP | sheetDefIn, |
double | topMarginIn, | ||
double | leftMarginIn, | ||
double | bottomMarginIn, | ||
double | rightMarginIn | ||
) |
For a sheet definition, set its margins.
[in] | sheetDefIn | sheet definition |
[in] | topMarginIn | top paper margin |
[in] | leftMarginIn | left paper margin |
[in] | bottomMarginIn | bottom paper margin |
[in] | rightMarginIn | right paper margin |
StatusInt mdlSheetDef_setPlotStyleTableFileName | ( | SheetDefP | sheetDefIn, |
WChar const * | pstFileNameIn | ||
) |
For a sheet definition, set the plot style table file name.
[in] | sheetDefIn | sheet definition |
[in] | pstFileNameIn | plot style table file name string |
StatusInt mdlSheetDef_setPrintStyleName | ( | SheetDefP | sheetDefIn, |
WChar const * | printStyleNameIn | ||
) |
For a sheet definition, set the print style name.
[in] | sheetDefIn | sheet definition |
[in] | printStyleNameIn | print style name string |
StatusInt mdlSheetDef_setRotation | ( | SheetDefP | sheetDefIn, |
double | sheetRotationIn | ||
) |
For a sheet definition, set rotation - relative to the X axis of the sheet model in the XY plane.
[in] | sheetDefIn | sheet definition |
[in] | sheetRotationIn | sheet rotation in radians |
StatusInt mdlSheetDef_setSheetNumber | ( | SheetDefP | sheetDefIn, |
UInt32 | sheetNumberIn | ||
) |
For a sheet definition, set sheet number.
[in] | sheetDefIn | sheet definition |
[in] | sheetNumberIn | sheet number |
StatusInt mdlSheetDef_setSize | ( | SheetDefP | sheetDefIn, |
double | sheetWidthIn, | ||
double | sheetHeightIn | ||
) |
For a sheet definition, set size.
[in] | sheetDefIn | sheet definition |
[in] | sheetWidthIn | sheet width |
[in] | sheetHeightIn | sheet height |
StatusInt mdlSheetDef_setUnits | ( | SheetDefP | sheetDefIn, |
DgnPlatform::UnitInfo const * | unitInfoIn | ||
) |
For a sheet definition, set its units.
[in] | sheetDefIn | sheet definition |
[out] | unitInfoIn | sheet units |