SAP 3D Visual Enterprise applications SDK
sDVLSceneInfo Struct Reference

#include <DVLScene.h>

Public Attributes

uint16_t m_uSizeOfDVLSceneInfo
 Size of the structure. You must set it to sizeof(sDVLSceneInfo) before calling RetrieveSceneInfo()
 
uint32_t m_uChildNodesCount
 Number of child nodes if DVLSCENEINFO_CHILDREN flag is passed. Otherwise 0.
 
DVLIDm_pChildNodes
 
uint32_t m_uSelectedNodesCount
 Number of selected nodes if DVLSCENEINFO_SELECTED flag is passed. Otherwise 0.
 
DVLIDm_pSelectedNodes
 
char * m_szLocalizationPrefix
 If DVLSCENEINFO_LOCALIZATION_PREFIX flag is specified, this member variable contains a UTF-8 prefix of the scene for localization. May be (and usually is) NULL.
 
float m_vSceneDimensions [2][3]
 
DVLID m_uStepId
 
float m_fStepTime
 
uint32_t m_uLayersCount
 Number of layers in the scene if DVLSCENEINFO_LAYERS flag is passed. Otherwise 0.
 
DVLIDm_pLayers
 
double m_dDisplayUnits
 DisplayUnits are user preference units. 0.001 stands for millimeter, 0.01 stands for centimeter etc.
 

Detailed Description

This structure is used to retrieve scene information from IDVLScene interface

NOTES

  • You need to initialize the m_uSizeOfDVLSceneInfo member of the sDVLSceneInfo structure with its size.
  • You need to call ReleaseSceneInfo() after each RetrieveSceneInfo()

Member Data Documentation

§ m_pChildNodes

DVLID* sDVLSceneInfo::m_pChildNodes

Array of child node identifiers and/or hotspot node identifiers. The size of the array is defined by m_uChildNodesCount member. If number of child nodes is 0, then m_pChildNodes is NULL. Note: if DVLSCENEINFO_HOTSPOTS is specified, then the "m_pChildNodes" array will also have hotspot nodes in it (they can be identified by the DVLNODEFLAG_HOTSPOT flag) Note: it is possible to combine DVLSCENEINFO_HOTSPOTS and DVLSCENEINFO_CHILDREN in a single call. Hotspots will have DVLNODEFLAG_HOTSPOT flag set and common child nodes will not have this flag

§ m_pLayers

DVLID* sDVLSceneInfo::m_pLayers

Array of layer identifiers. The size of the array is defined by m_uLayersCount member. If number of layers is 0, then m_pLayers is NULL.

§ m_pSelectedNodes

DVLID* sDVLSceneInfo::m_pSelectedNodes

Array of identifiers of selected nodes. The size of the array is defined by m_uSelectedNodesCount member. If number of selected nodes is 0, then m_pSelectedNodes is NULL.

§ m_vSceneDimensions

float sDVLSceneInfo::m_vSceneDimensions[2][3]

If DVLSCENEINFO_LOCALIZATION_PREFIX flag is specified, this member variable contains minimum and maximum X, Y and Z coordinates of the scene bounding box [0][0] = min x, [0][1] = min y, [0][2] = min z, [1][0] = max x, [1][1] = max y, [1][2] = max z


The documentation for this struct was generated from the following file: