Meta-data about an HDA, returned by HAPI_GetAssetInfo() More...

#include <HAPI_Common.h>

Public Attributes
HAPI_NodeId	nodeId

HAPI_NodeId	objectNodeId

HAPI_Bool	hasEverCooked

HAPI_StringHandle	nameSH

HAPI_StringHandle	labelSH
	Instance name (the label + a number). More...

HAPI_StringHandle	filePathSH
	This is what any end user should be shown. More...

HAPI_StringHandle	versionSH
	Path to the .otl library file. More...

HAPI_StringHandle	fullOpNameSH
	User-defined asset version. More...

HAPI_StringHandle	helpTextSH
	Full asset name and namespace. More...

HAPI_StringHandle	helpURLSH
	Asset help marked-up text. More...

int	objectCount
	Asset help URL. More...

int	handleCount
	See Objects. More...

int	transformInputCount
	See Handles. More...

int	geoInputCount

int	geoOutputCount

HAPI_Bool	haveObjectsChanged

HAPI_Bool	haveMaterialsChanged

Detailed Description

Meta-data about an HDA, returned by HAPI_GetAssetInfo()

Definition at line 1187 of file HAPI_Common.h.

Member Data Documentation

HAPI_StringHandle HAPI_AssetInfo::filePathSH

This is what any end user should be shown.

Definition at line 1208 of file HAPI_Common.h.

HAPI_StringHandle HAPI_AssetInfo::fullOpNameSH

User-defined asset version.

Definition at line 1210 of file HAPI_Common.h.

int HAPI_AssetInfo::geoInputCount

Geometry inputs exposed by the asset. For SOP assets this is the number of geometry inputs on the SOP node itself. OBJ assets will always have zero geometry inputs. See Asset Inputs.

Definition at line 1227 of file HAPI_Common.h.

int HAPI_AssetInfo::geoOutputCount

Geometry outputs exposed by the asset. For SOP assets this is the number of geometry outputs on the SOP node itself. OBJ assets will always have zero geometry outputs. See Asset Inputs.

Definition at line 1233 of file HAPI_Common.h.

int HAPI_AssetInfo::handleCount

See Objects.

Definition at line 1215 of file HAPI_Common.h.

HAPI_Bool HAPI_AssetInfo::hasEverCooked

It's possible to instantiate an asset without cooking it. See Cooking.

Definition at line 1204 of file HAPI_Common.h.

HAPI_Bool HAPI_AssetInfo::haveMaterialsChanged

For incremental updates. Indicates whether any of the asset's materials have changed. Refreshed only during an asset cook.

Definition at line 1241 of file HAPI_Common.h.

HAPI_Bool HAPI_AssetInfo::haveObjectsChanged

For incremental updates. Indicates whether any of the assets's objects have changed. Refreshed only during an asset cook.

Definition at line 1237 of file HAPI_Common.h.

HAPI_StringHandle HAPI_AssetInfo::helpTextSH

Full asset name and namespace.

Definition at line 1211 of file HAPI_Common.h.

HAPI_StringHandle HAPI_AssetInfo::helpURLSH

Asset help marked-up text.

Definition at line 1212 of file HAPI_Common.h.

HAPI_StringHandle HAPI_AssetInfo::labelSH

Instance name (the label + a number).

Definition at line 1207 of file HAPI_Common.h.

HAPI_StringHandle HAPI_AssetInfo::nameSH

Definition at line 1206 of file HAPI_Common.h.

HAPI_NodeId HAPI_AssetInfo::nodeId

Use the node id to get the asset's parameters. See Nodes Basics.

Definition at line 1191 of file HAPI_Common.h.

int HAPI_AssetInfo::objectCount

Asset help URL.

Definition at line 1214 of file HAPI_Common.h.

HAPI_NodeId HAPI_AssetInfo::objectNodeId

The objectNodeId differs from the regular nodeId in that for geometry based assets (SOPs) it will be the node id of the dummy object (OBJ) node instead of the asset node. For object based assets the objectNodeId will equal the nodeId. The reason the distinction exists is because transforms are always stored on the object node but the asset parameters may not be on the asset node if the asset is a geometry asset so we need both.

Definition at line 1200 of file HAPI_Common.h.

int HAPI_AssetInfo::transformInputCount

See Handles.

Transform inputs exposed by the asset. For OBJ assets this is the number of transform inputs on the OBJ node. For SOP assets, this is the singular transform input on the dummy wrapper OBJ node. See Asset Inputs.

Definition at line 1221 of file HAPI_Common.h.

HAPI_StringHandle HAPI_AssetInfo::versionSH

Path to the .otl library file.

Definition at line 1209 of file HAPI_Common.h.

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

HAPI/HAPI_Common.h

Public Attributes

Detailed Description

Member Data Documentation