STY_Types.h File Reference

#include "STY_API.h"
#include <UT/UT_Set.h>
#include <UT/UT_SharedPtr.h>
#include <UT/UT_StringMap.h>
#include <UT/UT_IntrusivePtr.h>
#include <UT/UT_Array.h>

Include dependency graph for STY_Types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	STY_ErrorScope

Typedefs
using	STY_Constant = UT_OptionEntry
using	STY_ConstantHandle = UT_SharedPtr< const STY_Constant >
using	STY_ConstantMap = UT_SortedStringMap< STY_ConstantHandle >
using	STY_OverrideScriptHandle = UT_IntrusivePtr< const STY_OverrideScript >
using	STY_OverrideScriptMap = UT_SortedStringMap< STY_OverrideScriptHandle >
using	STY_OverrideHandle = UT_IntrusivePtr< const STY_Override >
using	STY_OverrideMap = UT_SortedStringMap< STY_OverrideHandle >
using	STY_OverrideCategoryHandle = UT_IntrusivePtr< const STY_OverrideCategory >
using	STY_OverrideCategoryMap = UT_SortedStringMap< STY_OverrideCategoryHandle >
using	STY_TargetHandle = UT_IntrusivePtr< const STY_Target >
using	STY_StyleHandle = UT_IntrusivePtr< const STY_Style >
using	STY_SubjectHandle = UT_IntrusivePtr< STY_Subject >
using	STY_OverrideBlockHandle = UT_IntrusivePtr< const STY_OverrideBlock >
using	STY_OverrideBlockMap = UT_SortedStringMap< STY_OverrideBlockHandle >
using	STY_OverrideNames = UT_StringMap< UT_Set< UT_StringHolder > >
	Map of override categories to lists of override names. More...
using	STY_BindingHandle = UT_IntrusivePtr< const STY_Binding >
using	STY_BindingDataSourceHandle = UT_IntrusivePtr< const STY_BindingDataSource >
using	STY_TargetMatchClosureHandle = UT_IntrusivePtr< const STY_TargetMatchClosure >
using	STY_StylerMatchHandle = UT_IntrusivePtr< const STY_StylerMatch >
using	STY_StylerGroupMatchHandle = UT_IntrusivePtr< STY_StylerGroupMatch >
using	STY_MaterialHandle = UT_IntrusivePtr< const STY_Material >
using	STY_MaterialMap = UT_SortedStringMap< STY_MaterialHandle >
using	STY_StyleSheetHandle = UT_IntrusivePtr< const STY_StyleSheet >

Enumerations
enum	STY_StyleSheetLoadMode { STY_LOAD_FOR_STYLING, STY_LOAD_FOR_EDITING }
enum	STY_StyleSheetFlags { STY_STYLESHEET_NOFLAGS = 0x00, STY_STYLESHEET_SOLO = 0x01, STY_STYLESHEET_MUTE = 0x02 }
	Flags that may be set on stylesheets. More...
enum	STY_StyleFlags { STY_STYLEENTRY_NOFLAGS = 0x00, STY_STYLEENTRY_SOLO = 0x01, STY_STYLEENTRY_MUTE = 0x02, STY_STYLEENTRY_TARGETONLY = 0x04 }
	Flags that may be set on styles. More...

Variables
STY_API const UT_StringHolder	STY_OVERRIDE_MAT
	Style sheet categories. More...
STY_API const UT_StringHolder	STY_OVERRIDE_MAT_PARMS
STY_API const UT_StringHolder	STY_OVERRIDE_MAT_PROPERTIES
STY_API const UT_StringHolder	STY_OVERRIDE_SURFACE_PARMS
STY_API const UT_StringHolder	STY_OVERRIDE_DISPLACE_PARMS
STY_API const UT_StringHolder	STY_OVERRIDE_PROPERTIES
STY_API const UT_StringHolder	STY_REQUIREMENT_NAME
STY_API const UT_StringHolder	STY_REQUIREMENT_PATH
STY_API const UT_StringHolder	STY_REQUIREMENT_OBJNAME
	Object name: the name of the geometry object. More...
STY_API const UT_StringHolder	STY_REQUIREMENT_OBJCATEGORY
	Object tag: a tag expression tested against the geometry object tags. More...
STY_API const UT_StringHolder	STY_REQUIREMENT_OBJBUNDLE
	Object bundle: a bundle that tests the geometry object for membership. More...
STY_API const UT_StringHolder	STY_REQUIREMENT_PRIMGROUP
	Prim Group: ad-hoc primitive group the target needs to belong to). More...
STY_API const UT_StringHolder	STY_REQUIREMENT_POINTGROUP
	Point Group: ad-hoc point group the target needs to belong to). More...
STY_API const UT_StringHolder	STY_REQUIREMENT_VERTEXGROUP
	Vertex Group: eg, ad-hoc vertex group the target needs to belong to). More...
STY_API const UT_StringHolder	STY_REQUIREMENT_SHAPE
	Shape: shape, eg, the name of the agent's shape. More...

Typedef Documentation

using STY_BindingDataSourceHandle = UT_IntrusivePtr<const STY_BindingDataSource>

Definition at line 135 of file STY_Types.h.

using STY_BindingHandle = UT_IntrusivePtr<const STY_Binding>

Definition at line 130 of file STY_Types.h.

using STY_Constant = UT_OptionEntry

Definition at line 89 of file STY_Types.h.

using STY_ConstantHandle = UT_SharedPtr<const STY_Constant>

Definition at line 90 of file STY_Types.h.

using STY_ConstantMap = UT_SortedStringMap<STY_ConstantHandle>

Definition at line 91 of file STY_Types.h.

using STY_MaterialHandle = UT_IntrusivePtr<const STY_Material>

Definition at line 152 of file STY_Types.h.

using STY_MaterialMap = UT_SortedStringMap<STY_MaterialHandle>

Definition at line 153 of file STY_Types.h.

using STY_OverrideBlockHandle = UT_IntrusivePtr<const STY_OverrideBlock>

Definition at line 122 of file STY_Types.h.

using STY_OverrideBlockMap = UT_SortedStringMap<STY_OverrideBlockHandle>

Definition at line 123 of file STY_Types.h.

using STY_OverrideCategoryHandle = UT_IntrusivePtr<const STY_OverrideCategory>

Definition at line 105 of file STY_Types.h.

using STY_OverrideCategoryMap = UT_SortedStringMap<STY_OverrideCategoryHandle>

Definition at line 106 of file STY_Types.h.

using STY_OverrideHandle = UT_IntrusivePtr<const STY_Override>

Definition at line 100 of file STY_Types.h.

using STY_OverrideMap = UT_SortedStringMap<STY_OverrideHandle>

Definition at line 101 of file STY_Types.h.

using STY_OverrideNames = UT_StringMap< UT_Set<UT_StringHolder> >

Map of override categories to lists of override names.

Definition at line 126 of file STY_Types.h.

using STY_OverrideScriptHandle = UT_IntrusivePtr<const STY_OverrideScript>

Definition at line 95 of file STY_Types.h.

using STY_OverrideScriptMap = UT_SortedStringMap<STY_OverrideScriptHandle>

Definition at line 96 of file STY_Types.h.

using STY_StyleHandle = UT_IntrusivePtr<const STY_Style>

Definition at line 114 of file STY_Types.h.

using STY_StylerGroupMatchHandle = UT_IntrusivePtr<STY_StylerGroupMatch>

Definition at line 148 of file STY_Types.h.

using STY_StylerMatchHandle = UT_IntrusivePtr<const STY_StylerMatch>

Definition at line 144 of file STY_Types.h.

using STY_StyleSheetHandle = UT_IntrusivePtr<const STY_StyleSheet>

Definition at line 157 of file STY_Types.h.

using STY_SubjectHandle = UT_IntrusivePtr<STY_Subject>

Definition at line 118 of file STY_Types.h.

using STY_TargetHandle = UT_IntrusivePtr<const STY_Target>

Definition at line 110 of file STY_Types.h.

using STY_TargetMatchClosureHandle = UT_IntrusivePtr<const STY_TargetMatchClosure>

Definition at line 140 of file STY_Types.h.

Enumeration Type Documentation

enum STY_StyleFlags

Flags that may be set on styles.

Enumerator
STY_STYLEENTRY_NOFLAGS
STY_STYLEENTRY_SOLO
STY_STYLEENTRY_MUTE
STY_STYLEENTRY_TARGETONLY

Definition at line 78 of file STY_Types.h.

enum STY_StyleSheetFlags

Flags that may be set on stylesheets.

Enumerator
STY_STYLESHEET_NOFLAGS
STY_STYLESHEET_SOLO
STY_STYLESHEET_MUTE

Definition at line 70 of file STY_Types.h.

enum STY_StyleSheetLoadMode

We want to load style sheets differently depending on whether we are loading them to construct a STY_Styler and do actual styling, or if we are loading them to edit their contents in the UI.

Enumerator
STY_LOAD_FOR_STYLING
STY_LOAD_FOR_EDITING

Definition at line 63 of file STY_Types.h.

Variable Documentation

STY_API const UT_StringHolder STY_OVERRIDE_DISPLACE_PARMS

STY_API const UT_StringHolder STY_OVERRIDE_MAT

Style sheet categories.

STY_API const UT_StringHolder STY_OVERRIDE_MAT_PARMS

STY_API const UT_StringHolder STY_OVERRIDE_MAT_PROPERTIES

STY_API const UT_StringHolder STY_OVERRIDE_PROPERTIES

STY_API const UT_StringHolder STY_OVERRIDE_SURFACE_PARMS

STY_API const UT_StringHolder STY_REQUIREMENT_NAME

Common Target requirements. Name: the name of the target (eg, prim ID or its 'name' attrib value).

STY_API const UT_StringHolder STY_REQUIREMENT_OBJBUNDLE

Object bundle: a bundle that tests the geometry object for membership.

STY_API const UT_StringHolder STY_REQUIREMENT_OBJCATEGORY

Object tag: a tag expression tested against the geometry object tags.

STY_API const UT_StringHolder STY_REQUIREMENT_OBJNAME

Object name: the name of the geometry object.

STY_API const UT_StringHolder STY_REQUIREMENT_PATH

Path: for brevity it describes the target hierarchy in terms of a single string (similar to file paths).

STY_API const UT_StringHolder STY_REQUIREMENT_POINTGROUP

Point Group: ad-hoc point group the target needs to belong to).

STY_API const UT_StringHolder STY_REQUIREMENT_PRIMGROUP

Prim Group: ad-hoc primitive group the target needs to belong to).

STY_API const UT_StringHolder STY_REQUIREMENT_SHAPE

Shape: shape, eg, the name of the agent's shape.

STY_API const UT_StringHolder STY_REQUIREMENT_VERTEXGROUP

Vertex Group: eg, ad-hoc vertex group the target needs to belong to).