Classes
struct	sDVLSceneInfo

struct	sDVLURI

struct	sDVLNodeInfo

struct	sDVLLayerInfo

struct	sDVLMetadataNamespace

struct	sDVLMetadataNameValuePair

struct	sDVLMetadata

struct	sDVLMetadataInfo

struct	sDVLVEIDNameValuePair

struct	sDVLVEID

struct	sDVLVEIDInfo

struct	sDVLPartsListItem

struct	sDVLPartsListInfo

struct	sDVLStep

struct	sDVLProcedure

struct	sDVLProceduresInfo

struct	sDVLNodeIDsArrayInfo

class	IDVLScene

Macros
#define	DVLPARTSLIST_RECOMMENDED_uMaxParts 1000
	Recommended number of parts for a BuildPartsList() call.

#define	DVLPARTSLIST_RECOMMENDED_uMaxNodesInSinglePart 1000
	Recommended limitation of nodes in a single part for BuildPartsList() call.

#define	DVLPARTSLIST_RECOMMENDED_uMaxPartNameLength 200
	Recommended limitation of part name's length for BuildPartsList() call.

#define	DVLPARTSLIST_UNLIMITED_uMaxParts 0
	Do not limit the number of parts in BuildPartsList() call.

#define	DVLPARTSLIST_UNLIMITED_uMaxNodesInSinglePart 0
	Do not limit the number of nodes in a part for BuildPartsList() call.

#define	DVLPARTSLIST_UNLIMITED_uMaxPartNameLength 0
	Do not limit the part's name length for BuildPartsList() call.

Enumerations
enum	DVLSCENEINFO { DVLSCENEINFO_CHILDREN = (1 << 0), DVLSCENEINFO_SELECTED = (1 << 1), DVLSCENEINFO_LOCALIZATION_PREFIX = (1 << 2), DVLSCENEINFO_DIMENSIONS = (1 << 3), DVLSCENEINFO_STEP_INFO = (1 << 4), DVLSCENEINFO_LAYERS = (1 << 5), DVLSCENEINFO_DISPLAY_UNITS = (1 << 6), DVLSCENEINFO_MATERIALS = (1 << 7), DVLSCENEINFO_HOTSPOTS = (1 << 8), DVLSCENEINFO_HOTSPOT_LAYERS = (1 << 9) }
	Defines the scene information flags to be used in IDVLScene::RetrieveSceneInfo() More...

enum	DVLNODEINFO { DVLNODEINFO_NAME = 0x0001, DVLNODEINFO_ASSETID = 0x0002, DVLNODEINFO_UNIQUEID = 0x0004, DVLNODEINFO_PARENTS = 0x0008, DVLNODEINFO_CHILDREN = 0x0010, DVLNODEINFO_FLAGS = 0x0020, DVLNODEINFO_OPACITY = 0x0040, DVLNODEINFO_HIGHLIGHT_COLOR = 0x0080, DVLNODEINFO_URI = 0x0100, DVLNODEINFO_INFO = 0x0200 }
	Defines the node information flags to be used in IDVLScene::RetrieveNodeInfo() More...

enum	eDVLPartsListType { DVLPARTSLISTTYPE_ALL = 0, DVLPARTSLISTTYPE_VISIBLE = 1, DVLPARTSLISTTYPE_CONSUMED_BY_STEP = 2 }

enum	eDVLPartsListSort { DVLPARTSLISTSORT_NAME_ASCENDING = 0, DVLPARTSLISTSORT_NAME_DESCENDING = 1, DVLPARTSLISTSORT_COUNT_ASCENDING = 2, DVLPARTSLISTSORT_COUNT_DESCENDING = 3 }

enum	eDVLFindNodeType { DVLFINDNODETYPE_NODE_NAME = 0, DVLFINDNODETYPE_ASSET_ID = 1, DVLFINDNODETYPE_UNIQUE_ID = 2, DVLFINDNODETYPE_DSSELECTOR_ID = 3 }

enum	eDVLFindNodeMode { DVLFINDNODEMODE_EQUAL = 0, DVLFINDNODEMODE_EQUAL_CASE_INSENSITIVE = 1, DVLFINDNODEMODE_SUBSTRING = 2, DVLFINDNODEMODE_SUBSTRING_CASE_INSENSITIVE = 3, DVLFINDNODEMODE_STARTS_WITH = 4, DVLFINDNODEMODE_STARTS_WITH_CASE_INSENSITIVE = 5 }

Detailed Description

This header defines the Scene interface

Enumeration Type Documentation

§ DVLNODEINFO

enum DVLNODEINFO

Defines the node information flags to be used in IDVLScene::RetrieveNodeInfo()

Enumerator
DVLNODEINFO_NAME	Retrieve the node name.
DVLNODEINFO_ASSETID	Retrieve the node asset id.
DVLNODEINFO_UNIQUEID	Retrieve the node unique id.
DVLNODEINFO_PARENTS	Retrieve parents of the node.
DVLNODEINFO_CHILDREN	Retrieve children of the node.
DVLNODEINFO_FLAGS	Retrieve node flags.
DVLNODEINFO_OPACITY	Retrieve node opacity.
DVLNODEINFO_HIGHLIGHT_COLOR	Retrieve node highlight color.
DVLNODEINFO_URI	Retrieve node URIs.
DVLNODEINFO_INFO	Retrieve the node additional information. Used only for the hotspots.

§ DVLSCENEINFO

enum DVLSCENEINFO

Defines the scene information flags to be used in IDVLScene::RetrieveSceneInfo()

Enumerator
DVLSCENEINFO_CHILDREN	Retrieve the list of child nodes.
DVLSCENEINFO_SELECTED	Retrieve the list of selected nodes.
DVLSCENEINFO_LOCALIZATION_PREFIX	Retrieve the prefix for scene localization.
DVLSCENEINFO_DIMENSIONS	Retrieve scene dimensions.
DVLSCENEINFO_STEP_INFO	Retrieve current step info.
DVLSCENEINFO_LAYERS	Retrieve a list of layers.
DVLSCENEINFO_DISPLAY_UNITS	Retrieve display units.
DVLSCENEINFO_MATERIALS	Retrieve materials.
DVLSCENEINFO_HOTSPOTS	Retrieve hotspots (some of top level nodes have a 'hotspot' flag. Nodes with hotspot flag may only have children with hotspot flag. And nodes without a hotspot flag may only have children without a hotspot flag)
DVLSCENEINFO_HOTSPOT_LAYERS	Retrieve a list of hotspot layers (hotspot layers may only have hotspot nodes inside them)

§ eDVLFindNodeMode

enum eDVLFindNodeMode

Defines the string comparison mode

Enumerator
DVLFINDNODEMODE_EQUAL	Match nodes by comparing node name/assetid/uniqueid with "str" (case sensitive, fastest option [does buffer compare without UTF8 parsing])
DVLFINDNODEMODE_EQUAL_CASE_INSENSITIVE	Match nodes by comparing node name/assetid/uniqueid with "str" (case insensitive, UTF8-aware)
DVLFINDNODEMODE_SUBSTRING	Match nodes by finding "str" substring in node name/assetid/uniqueid (case sensitive, UTF8-aware)
DVLFINDNODEMODE_SUBSTRING_CASE_INSENSITIVE	Match nodes by finding "str" substring in node name/assetid/uniqueid (case insensitive, UTF8-aware)
DVLFINDNODEMODE_STARTS_WITH	Match nodes by comparing first "strlen(str)" symbols of node name/assetid/uniqueid with "str" (case sensitive, UTF8-aware)
DVLFINDNODEMODE_STARTS_WITH_CASE_INSENSITIVE	Match nodes by comparing first "strlen(str)" symbols of node name/assetid/uniqueid with "str" (case insensitive, UTF8-aware)

§ eDVLFindNodeType

enum eDVLFindNodeType

Defines the type of node search to perform

Enumerator
DVLFINDNODETYPE_NODE_NAME	Find node by "node name".
DVLFINDNODETYPE_ASSET_ID	Find node by "asset id" (asset id is stored inside some VDS files [it is optional])
DVLFINDNODETYPE_UNIQUE_ID	Find node by "unique id" (unique id is stored inside some VDS files [it is optional])
DVLFINDNODETYPE_DSSELECTOR_ID	Find node by "DS selector id" (unique id is stored inside some VDS files [it is optional])

§ eDVLPartsListSort

enum eDVLPartsListSort

Defines the sorting order for the parts list

Enumerator
DVLPARTSLISTSORT_NAME_ASCENDING	Sort from A to Z.
DVLPARTSLISTSORT_NAME_DESCENDING	Sort from Z to A.
DVLPARTSLISTSORT_COUNT_ASCENDING	Sort by the number of nodes in the part, parts with smaller number of nodes go first.
DVLPARTSLISTSORT_COUNT_DESCENDING	Sort by the number of nodes in the part, parts with larger number of nodes go first.

§ eDVLPartsListType

enum eDVLPartsListType

Defines the type of parts to put in the list

Enumerator
DVLPARTSLISTTYPE_ALL	Build a list using all the nodes.
DVLPARTSLISTTYPE_VISIBLE	Build a list using only the visible nodes.
DVLPARTSLISTTYPE_CONSUMED_BY_STEP	Build a list using only the nodes, consumed by a particular step (step DVLID is passed as a parameter to the BuildPartsList() call)

Classes

Macros

Enumerations