CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfcGsManager Namespace Reference

Functions

IFCCORE_EXPORT OdGsIfcLayoutHelperPtr setupActiveLayoutViews (OdGsDevice *pDevice, OdGiContextForIfcDatabase *pGiCtx)
 
IFCCORE_EXPORT void setupPalette (OdGsDevice *device, OdGiContextForIfcDatabase *giContext, OdDbStub *layoutId=0, ODCOLORREF palBackground=ODRGBA(0, 0, 0, 0))
 

Detailed Description

Contains declarations of common functions for Gs object management.

Function Documentation

◆ setupActiveLayoutViews()

IFCCORE_EXPORT OdGsIfcLayoutHelperPtr OdIfcGsManager::setupActiveLayoutViews ( OdGsDevice * pDevice,
OdGiContextForIfcDatabase * pGiCtx )

Sets active views for the layout.

Parameters
reprContextId[in] An identifier of a representation context object.
pDevice[in] A raw pointer to a <exref target="https://docs.opendesign.com/tv_api_cpp/OdGsDevice.html">Gs device</exref> object.
pGiCtx[in] A raw pointer to a <exref target="https://docs.opendesign.com/tifc_api_cpp/OdGiContextForIfcDatabase.html>Gi context object</exref> for the IFC database. \returns Returns a smart pointer to the <exref target="https://docs.opendesign.com/tifc_api_cpp/OdGsIfcLayoutHelper.html>OdGsDevice-derived IFC wrapper object</exref> that handles appropriate <exref target="https://docs.opendesign.com/tv_api_cpp/OdGsDevice.html">OdGsDevice</exref> object calls.

◆ setupPalette()

IFCCORE_EXPORT void OdIfcGsManager::setupPalette ( OdGsDevice * device,
OdGiContextForIfcDatabase * giContext,
OdDbStub * layoutId = 0,
ODCOLORREF palBackground = ODRGBA(0, 0, 0, 0) )

Sets layout views.

Parameters
layoutId[in] A layout object identifier.
pDevice[in] A pointer to a Gs device.
pGiCtx[in] A pointer to a PRC database context.
Returns
Returns an OdGsDevice-derived wrapper that handles OdGsDevice object calls.

Sets a new palette associated with a specified layout for a specified <exref target="https://docs.opendesign.com/tv_api_cpp/OdGsDevice.html">OdGsDevice</exref>-derived object.

Parameters
device[in] A raw pointer to an <exref target="https://docs.opendesign.com/tv_api_cpp/OdGsDevice.html">OdGsDevice</exref>-derived object.
giContext[in] A raw pointer to a <exref target="https://docs.opendesign.com/tifc_api_cpp/OdGiContextForIfcDatabase.html>Gi context object</exref> for the IFC database.
layoutId[in] A pointer to an identifier of the layout object.
palBackground[in] A new palette background color value to be set.