Namespaces
namespace	GlobalSelection

namespace	NamedSelection

namespace	PathString

Classes
class	AreaLightInterface

class	Array
	Array is a container class that encapsulates dynamic sized arrays. More...

class	Attribute
	Abstract base class for Attribute interface. More...

class	AttributeAdded
	Attribute added notification. More...

class	AttributeChanged
	Base class for all attribute changed notifications. More...

class	AttributeConnectionChanged
	Attribute connection changed notification. More...

class	AttributeDef
	Base class for Attribute definitions. More...

class	AttributeEnumString
	Attribute which has a list of strings as enumerated values. More...

class	AttributeFilename
	Attribute which represents a filename. More...

class	AttributeGeneric
	Generic attribute which doesn't match any defined type. More...

class	AttributeInfo
	This class keeps information of an attribute. More...

class	AttributeMetadataChanged
	Attribute metadata changed notification. More...

class	AttributeRemoved
	Attribute removed notification. More...

class	Attributes
	Abstract base class for Attributes interface. More...

class	AttributesHandler
	Factory base class for Attributes interface. More...

class	AttributeUndoableCommand
	Command to add an attribute to a scene item. More...

class	AttributeValueChanged
	Attribute value changed notification. More...

class	BaseUndoableCommand
	Base class for undoable set operation commands. More...

class	BatchCompositeCommand
	Composite command affecting a batch (selection) of items. For each item run-time, allow the run-time to wrap the execution of the composite commmand with arbitrary prelude and cleanup code. More...

class	BatchOpsHandler
	Provides services to properly manage complex sequences of operations using bracketed guards. More...

struct	BBox3d
	3D bounding box class. More...

class	Camera
	Abstract base class for camera interface. More...

class	CameraChanged
	Base class for all Camera notifications. More...

class	CameraHandler
	Factory base class for Camera interface. More...

struct	CellInfo
	Structure for information to draw a text cell. More...

struct	ChildFilterFlag
	Structure to describe child filtering. More...

class	ClipboardHandler

class	CodeWrapper
	Wrap the execution of some other function, called sub-operation, with arbitrary prelude and cleanup virtual functions. More...

class	CodeWrapperContainer
	A container of multiple CodeWrapper, one per UFE run-time that is involved in an operation. More...

class	CodeWrapperContext
	Wraps execution of other code by calling the prelude and cleanup code wrappers for given sub-operation. More...

class	CodeWrapperHandler
	Provides services to create code wrapper around operations affecting a selection of scene items. More...

class	ColorManagementChanged
	Color management changed notification. More...

class	ColorManagementHandler
	Provides a minimal color management interface that allows clients to query settings related to input color spaces. More...

class	CompositeUndoableCommand
	Composite undoable command. More...

class	Connection
	This class represents a connection. More...

class	ConnectionHandler
	Factory base class for connection interface. More...

class	ConnectionResultUndoableCommand
	Command that modifies the data model and produces either a new or modified Connection. More...

class	Connections
	The class represents a list of existing connections. More...

struct	ContextItem
	Structure to describe contextual operations. More...

class	ContextOps
	Abstract base class for context operations interface. More...

class	ContextOpsHandler
	Factory base class for ContextOps interface. More...

struct	Duplicate
	Result for undoable duplicate item. More...

class	EditTransform3dHint
	Hint class for Transform3d editTransform3d. More...

class	EmptyClipboardOperation
	Exception class to signal empty clipboard operation (cut/copy/paste). More...

class	EmptyClipboardSelection
	Exception class to signal empty clipboard Selection (cut/copy/paste). More...

class	EmptyPathSegment
	Exception class to signal empty path segment in path string. More...

class	HandlerInterface

class	Hierarchy
	Abstract base class for scene hierarchy interface. More...

class	HierarchyHandler
	Factory base class for scene hierarchy interface. More...

class	InsertChildCommand
	Command to change the parent of a scene item. More...

class	InvalidOperationOnPath
	Exception class to signal an invalid path. More...

class	InvalidOperationOnPathSegment
	Exception class to signal an invalid path. More...

class	InvalidPath
	Exception class to signal an invalid path. More...

class	InvalidPathComponentSeparator
	Exception class to signal an unknown path component separator in a path string. More...

class	InvalidRunTimeId
	Exception class to signal an invalid runtime ID. More...

class	InvalidRunTimeName
	Exception class to signal unknown runtime ID. More...

class	InvalidValueGet
	Exception class to signal if the template type doesn't match the type of the actual value. More...

class	Light
	Abstract base class for light interface. More...

class	Light2

class	Light2Handler
	Factory base class for Light2 interface. More...

class	Light2MetadataChanged
	Light2 metadata changed notification. More...

class	LightChanged
	Base class for all Light notifications. More...

class	LightHandler
	Factory base class for Light interface. More...

class	LightInterface

class	Material
	Abstract base class for Material interface. More...

class	MaterialHandler
	Factory base class for Material interface. More...

class	NoClipboardHandler
	Exception class to signal no clipboard handler implemented for runtime. More...

class	NodeDef
	Abstract base class for NodeDef interface. More...

class	NodeDefHandler
	Base class for NodeDefHandler interface. More...

class	Notification
	Base class for all notifications. More...

class	NotificationGuard
	Notification guard for Subject. More...

class	Object3d
	Abstract base class for 3D object interface. More...

class	Object3dHandler
	Factory base class for Object3d interface. More...

class	ObjectAdd
	Base class for object add scene notifications. More...

class	ObjectDelete
	Base class for object delete scene notifications. More...

class	ObjectDestroyed
	Object destroyed scene notification that occurs once an object is destroyed. More...

class	ObjectPathAdd
	Path added to object scene notification. More...

class	ObjectPathChange
	Base class for object path change scene notifications. More...

class	ObjectPathRemove
	Path removed from object scene notification. More...

class	ObjectPostDelete
	Object delete scene notifications that occur after the object was deleted. More...

class	ObjectPreDelete
	Object delete scene notifications that occur before the object is deleted. More...

class	ObjectRename
	Object renamed scene notification. More...

class	ObjectReparent
	Object reparented scene notification. More...

class	ObservableSelection
	Observable selection for objects in the scene. More...

class	Observer
	Observer pattern Observer class. More...

class	PasteClipboardCommand
	Command that handles paste from clipboard. More...

class	Path
	Identify an object or 3D path in the scene. More...

class	PathComponent
	Constant string representation with fixed space and O(1) comparison. More...

class	PathMappingHandler

class	PathSegment
	A segment of a path within a single runtime. More...

class	PathSubject
	Helper to make a Path observable. More...

struct	Rename
	Result for undoable rename item. More...

class	RunTimeMgr
	Singleton class to manage UFE runtimes. More...

class	Scene
	Singleton class to manage UFE scenes. More...

class	SceneChanged
	Base class for all scene notifications. More...

class	SceneCompositeNotification
	SceneChanged composite notification. More...

class	SceneItem
	Universal Front End abstract scene item. More...

class	SceneItemOps
	Abstract base class for scene item operations interface. More...

class	SceneItemOpsHandler
	Factory base class for SceneItemOps interface. More...

class	SceneItemResultUndoableCommand
	Command that modifies the data model and produces either a new or modified SceneItem. More...

class	SceneSegmentHandler
	Provides services that operate on a scene segment. This base class defines an interface that runtimes can implement to provide services for a scene segment. More...

class	Selection
	Selection list for objects in the scene. More...

class	SelectionAppendItem
	Append an item to the argument selection. More...

class	SelectionChanged
	Base class for all selection notifications. More...

class	SelectionClear
	Clear the argument selection. More...

class	SelectionCleared
	Selection cleared notification. More...

class	SelectionCompositeNotification
	Selection composite notification. More...

class	SelectionItemAppended
	Item added to selection notification. More...

class	SelectionItemInserted
	Item inserted into selection notification. More...

class	SelectionItemRemoved
	Item removed from selection notification. More...

class	SelectionRemoveItem
	Remove an item from the argument selection. More...

class	SelectionReplaced
	Selection replaced notification. More...

class	SelectionReplaceWith
	Replace the argument selection. More...

class	SelectionUndoableCommand
	Command that handles a selection. More...

class	SetValue2UndoableCommand
	Abstract class for set Value2 command. More...

class	SetValue3UndoableCommand
	Abstract class for set Value3 command. More...

class	SetValue4UndoableCommand
	Abstract class for set Value4 command. More...

class	SetValueUndoableCommand
	Abstract class for set value command. More...

class	Subject
	Observer pattern Subject class. More...

class	SubtreeInvalidate
	Subtree invalidate notification. More...

class	Transform3d
	Abstract base class for 3D transform interface. More...

class	Transform3dChanged
	Base class for all Transform3d notifications. More...

class	Transform3dHandler
	Factory base class for Transform3d interface. More...

class	Transform3dPathSubject
	Helper to observe transform3d changes on a path. More...

class	Transform3dRead
	Read-only abstract base class for 3D transform interface. More...

class	Trie
	Node for Universal Front End trie. More...

class	TrieNode

class	TypedAttribute
	Typed attribute template for creating a specialized type. More...

struct	TypedColorN
	Typed color template for creating a specialized color. More...

struct	TypedSquareMatrixN
	Typed square matrix template. More...

struct	TypedVectorN
	Typed vector template for creating a specialized vector with N elements. More...

class	UIInfoHandler

class	UINodeGraphNode
	Abstract base class for UINodeGraphNode interface. More...

class	UINodeGraphNodeHandler
	Factory base class for UINodeGraphNode interface. More...

class	UndoableCommand
	Abstract base class for undoable commands. More...

class	UndoableCommandGuard

class	UndoableCommandMgr
	Abstract base class for undoable command manager. More...

class	Value
	Value class that can hold a wide set of types. More...

class	VersionInfo
	Version information of UFE. More...

class	VisibilityChanged
	Visibility changed notification. More...

Typedefs
typedef Array< bool >	BoolArray

typedef Array< int >	IntArray

typedef Array< unsigned int >	UIntArray

typedef Array< float >	FloatArray

typedef Array< double >	DoubleArray

typedef Array< std::string >	StringArray

typedef Array< Vector2i >	Vector2iArray

typedef Array< Vector2f >	Vector2fArray

typedef Array< Vector2d >	Vector2dArray

typedef Array< Vector3i >	Vector3iArray

typedef Array< Vector3f >	Vector3fArray

typedef Array< Vector3d >	Vector3dArray

typedef Array< Vector4i >	Vector4iArray

typedef Array< Vector4f >	Vector4fArray

typedef Array< Vector4d >	Vector4dArray

typedef Array< Color3f >	Color3fArray

typedef Array< Color4f >	Color4fArray

typedef Array< Matrix3d >	Matrix3dArray

typedef Array< Matrix4d >	Matrix4dArray

typedef TypedAttribute< bool >	AttributeBool
	Specialized typed attribute for boolean values. More...

typedef TypedAttribute< int >	AttributeInt
	Specialized typed attribute for integer values. More...

typedef TypedAttribute< unsigned int >	AttributeUInt
	Specialized typed attribute for integer values. More...

typedef TypedAttribute< float >	AttributeFloat
	Specialized typed attribute for float values. More...

typedef TypedAttribute< double >	AttributeDouble
	Specialized typed attribute for double values. More...

typedef TypedAttribute< std::string >	AttributeString
	Specialized typed attribute for string values. More...

typedef TypedAttribute< Color3f >	AttributeColorFloat3
	Specialized typed attribute for color (3 float) values. More...

typedef TypedAttribute< Color4f >	AttributeColorFloat4
	Specialized typed attribute for color (4 float) values. More...

typedef TypedAttribute< Vector3i >	AttributeInt3
	Specialized typed attribute for 3 integer (vector) values. More...

typedef TypedAttribute< Vector2f >	AttributeFloat2
	Specialized typed attribute for 2 float (vector) values. More...

typedef TypedAttribute< Vector3f >	AttributeFloat3
	Specialized typed attribute for 3 float (vector) values. More...

typedef TypedAttribute< Vector4f >	AttributeFloat4
	Specialized typed attribute for 4 float (vector) values. More...

typedef TypedAttribute< Vector3d >	AttributeDouble3
	Specialized typed attribute for 3 double (vector) values. More...

typedef TypedAttribute< Matrix3d >	AttributeMatrix3d
	Specialized typed attribute for 3x3 double (matrix) values. More...

typedef TypedAttribute< Matrix4d >	AttributeMatrix4d
	Specialized typed attribute for 4x4 double (matrix) values. More...

typedef TypedAttribute< BoolArray >	AttributeBoolArray
	Specialized typed attribute for an array of boolean values. More...

typedef TypedAttribute< IntArray >	AttributeIntArray
	Specialized typed attribute for an array of integer values. More...

typedef TypedAttribute< UIntArray >	AttributeUIntArray
	Specialized typed attribute for an array of unsigned integer values. More...

typedef TypedAttribute< FloatArray >	AttributeFloatArray
	Specialized typed attribute for an array of float values. More...

typedef TypedAttribute< DoubleArray >	AttributeDoubleArray
	Specialized typed attribute for an array of double values. More...

typedef TypedAttribute< StringArray >	AttributeStringArray
	Specialized typed attribute for an array of string values. More...

typedef TypedAttribute< Vector2iArray >	AttributeInt2Array
	Specialized typed attribute for an array of 2 integer (vector) values. More...

typedef TypedAttribute< Vector2fArray >	AttributeFloat2Array
	Specialized typed attribute for an array of 2 float (vector) values. More...

typedef TypedAttribute< Vector2dArray >	AttributeDouble2Array
	Specialized typed attribute for an array of 2 double (vector) values. More...

typedef TypedAttribute< Vector3iArray >	AttributeInt3Array
	Specialized typed attribute for an array of 3 integer (vector) values. More...

typedef TypedAttribute< Vector3fArray >	AttributeFloat3Array
	Specialized typed attribute for an array of 3 float (vector) values. More...

typedef TypedAttribute< Vector3dArray >	AttributeDouble3Array
	Specialized typed attribute for an array of 3 double (vector) values. More...

typedef TypedAttribute< Vector4iArray >	AttributeInt4Array
	Specialized typed attribute for an array 4 integer (vector) values. More...

typedef TypedAttribute< Vector4fArray >	AttributeFloat4Array
	Specialized typed attribute for an array 4 float (vector) values. More...

typedef TypedAttribute< Vector4dArray >	AttributeDouble4Array
	Specialized typed attribute for an array 4 double (vector) values. More...

typedef TypedAttribute< Color3fArray >	AttributeColorFloat3Array
	Specialized typed attribute for an array of 3 float (color) values. More...

typedef TypedAttribute< Color4fArray >	AttributeColorFloat4Array
	Specialized typed attribute for an array of 4 float (color) values. More...

typedef TypedAttribute< Matrix3dArray >	AttributeMatrixDouble3Array
	Specialized typed attribute for an array 3 double (matrix) values. More...

typedef TypedAttribute< Matrix4dArray >	AttributeMatrixDouble4Array
	Specialized typed attribute for an array of 4 double (matrix) values. More...

typedef AttributeUndoableCommand	AddAttributeUndoableCommand

typedef AttributeUndoableCommand	RenameAttributeUndoableCommand

using	SetFloatUndoableCommand = SetValueUndoableCommand< float >

using	SetDoubleUndoableCommand = SetValueUndoableCommand< double >

using	SetMatrix3dUndoableCommand = SetValueUndoableCommand< const Matrix3d & >

using	SetMatrix4dUndoableCommand = SetValueUndoableCommand< const Matrix4d & >

using	SetBoolUndoableCommand = SetValueUndoableCommand< bool >

using	SetIntUndoableCommand = SetValueUndoableCommand< int >

using	SetVector2fUndoableCommand = SetValue2UndoableCommand< float >

using	SetVector3fUndoableCommand = SetValue3UndoableCommand< float >

using	SetVector4fUndoableCommand = SetValue4UndoableCommand< float >

using	SetVector3dUndoableCommand = SetValue3UndoableCommand< double >

using	SetColor3fUndoableCommand = SetValueUndoableCommand< const Color3f & >

using	SetColor4fUndoableCommand = SetValueUndoableCommand< const Color4f & >

typedef SetFloatUndoableCommand	HorizontalApertureUndoableCommand

typedef SetFloatUndoableCommand	VerticalApertureUndoableCommand

typedef SetFloatUndoableCommand	HorizontalApertureOffsetUndoableCommand

typedef SetFloatUndoableCommand	VerticalApertureOffsetUndoableCommand

typedef SetFloatUndoableCommand	FStopUndoableCommand

typedef SetFloatUndoableCommand	FocalLengthUndoableCommand

typedef SetFloatUndoableCommand	FocusDistanceUndoableCommand

typedef SetFloatUndoableCommand	NearClipPlaneUndoableCommand

typedef SetFloatUndoableCommand	FarClipPlaneUndoableCommand

typedef SetIntUndoableCommand	ProjectionUndoableCommand

typedef std::vector< AttributeDef::ConstPtr >	ConstAttributeDefs

typedef std::vector< NodeDef::Ptr >	NodeDefs

typedef uint32_t	Rtid

typedef std::list< std::shared_ptr< SceneItem > >	SceneItemList

typedef Trie< Ufe::SceneItemList::iterator >	SelectionTrie

typedef SetVector3dUndoableCommand	TranslateUndoableCommand

typedef SetVector3dUndoableCommand	RotateUndoableCommand

typedef SetVector3dUndoableCommand	ScaleUndoableCommand

typedef SetVector3dUndoableCommand	ShearUndoableCommand

typedef TypedVectorN< int, 2 >	Vector2i

typedef TypedVectorN< float, 2 >	Vector2f

typedef TypedVectorN< double, 2 >	Vector2d

typedef TypedVectorN< int, 3 >	Vector3i

typedef TypedVectorN< float, 3 >	Vector3f

typedef TypedVectorN< double, 3 >	Vector3d

typedef TypedVectorN< int, 4 >	Vector4i

typedef TypedVectorN< float, 4 >	Vector4f

typedef TypedVectorN< double, 4 >	Vector4d

typedef TypedColorN< float, 3 >	Color3f

typedef TypedColorN< float, 4 >	Color4f

typedef TypedSquareMatrixN< double, 3 >	Matrix3d

typedef TypedSquareMatrixN< double, 4 >	Matrix4d

using	SceneItemPtr = std::shared_ptr< SceneItem >

using	UndoableCommandPtr = std::shared_ptr< UndoableCommand >

using	ValueDictionary = std::unordered_map< std::string, Value >

Functions
template<class T >
std::ostream &	operator<< (std::ostream &os, const TypedVectorN< T, 2 > &v)

template<class T >
std::ostream &	operator<< (std::ostream &os, const TypedVectorN< T, 3 > &v)

template<class T >
std::ostream &	operator<< (std::ostream &os, const TypedVectorN< T, 4 > &v)

std::ostream &	operator<< (std::ostream &os, const Matrix3d &m)

std::ostream &	operator<< (std::ostream &os, const Matrix4d &m)

std::ostream &	operator<< (std::ostream &os, const BBox3d &bbox)

void	log (const char func, const char filename, int lineno, const std::string &msg)

uint64_t	getRawAddress (const SceneItem::Ptr &item)

SceneItem::Ptr	getSceneItemFromRaw (uint64_t raw)

uint64_t	getRawAddress (const Attributes::Ptr &item)

Attributes::Ptr	getAttributesFromRaw (uint64_t raw)

std::string	lstrip (std::string src, char toStrip)

std::vector< std::string >	split (const std::string &src, char sep)

std::vector< std::string >	split (const std::string &src, const std::string &sep)

bool	endsWith (const std::string &str, const std::string &suffix)

template<typename T , std::size_t SZ>
std::istream &	operator>> (std::istream &is, TypedVectorN< T, SZ > &v)

template<typename T , std::size_t SZ>
std::ostream &	operator<< (std::ostream &os, const TypedVectorN< T, SZ > &v)

template<typename T , std::size_t SZ>
std::istream &	operator>> (std::istream &is, TypedColorN< T, SZ > &c)

template<typename T , std::size_t SZ>
std::ostream &	operator<< (std::ostream &os, const TypedColorN< T, SZ > &c)

template<typename T , std::size_t SZ>
std::istream &	operator>> (std::istream &is, TypedSquareMatrixN< T, SZ > &m)

template<typename T , std::size_t SZ>
std::ostream &	operator<< (std::ostream &os, const TypedSquareMatrixN< T, SZ > &m)

void	handleAssert (const char func, const char filename, int lineno, const char expr, const char msg)

Typedef Documentation

◆ AddAttributeUndoableCommand

typedef AttributeUndoableCommand Ufe::AddAttributeUndoableCommand

Definition at line 17 of file attributesUndoableCommands.h.

◆ AttributeBool

TypedAttribute< bool > Ufe::AttributeBool

Specialized typed attribute for boolean values.

Definition at line 360 of file attribute.h.

◆ AttributeBoolArray

TypedAttribute< BoolArray > Ufe::AttributeBoolArray

Specialized typed attribute for an array of boolean values.

Definition at line 428 of file attribute.h.

◆ AttributeColorFloat3

TypedAttribute< Color3f > Ufe::AttributeColorFloat3

Specialized typed attribute for color (3 float) values.

Definition at line 384 of file attribute.h.

◆ AttributeColorFloat3Array

TypedAttribute< Color3fArray > Ufe::AttributeColorFloat3Array

Specialized typed attribute for an array of 3 float (color) values.

Definition at line 488 of file attribute.h.

◆ AttributeColorFloat4

TypedAttribute< Color4f > Ufe::AttributeColorFloat4

Specialized typed attribute for color (4 float) values.

Definition at line 388 of file attribute.h.

◆ AttributeColorFloat4Array

TypedAttribute< Color4fArray > Ufe::AttributeColorFloat4Array

Specialized typed attribute for an array of 4 float (color) values.

Definition at line 492 of file attribute.h.

◆ AttributeDouble

TypedAttribute< double > Ufe::AttributeDouble

Specialized typed attribute for double values.

Definition at line 376 of file attribute.h.

◆ AttributeDouble2Array

TypedAttribute< Vector2dArray > Ufe::AttributeDouble2Array

Specialized typed attribute for an array of 2 double (vector) values.

Definition at line 460 of file attribute.h.

◆ AttributeDouble3

TypedAttribute< Vector3d > Ufe::AttributeDouble3

Specialized typed attribute for 3 double (vector) values.

Definition at line 408 of file attribute.h.

◆ AttributeDouble3Array

TypedAttribute< Vector3dArray > Ufe::AttributeDouble3Array

Specialized typed attribute for an array of 3 double (vector) values.

Definition at line 472 of file attribute.h.

◆ AttributeDouble4Array

TypedAttribute< Vector4dArray > Ufe::AttributeDouble4Array

Specialized typed attribute for an array 4 double (vector) values.

Definition at line 484 of file attribute.h.

◆ AttributeDoubleArray

TypedAttribute< DoubleArray > Ufe::AttributeDoubleArray

Specialized typed attribute for an array of double values.

Definition at line 444 of file attribute.h.

◆ AttributeFloat

TypedAttribute< float > Ufe::AttributeFloat

Specialized typed attribute for float values.

Definition at line 372 of file attribute.h.

◆ AttributeFloat2

TypedAttribute< Vector2f > Ufe::AttributeFloat2

Specialized typed attribute for 2 float (vector) values.

Definition at line 396 of file attribute.h.

◆ AttributeFloat2Array

TypedAttribute< Vector2fArray > Ufe::AttributeFloat2Array

Specialized typed attribute for an array of 2 float (vector) values.

Definition at line 456 of file attribute.h.

◆ AttributeFloat3

TypedAttribute< Vector3f > Ufe::AttributeFloat3

Specialized typed attribute for 3 float (vector) values.

Definition at line 400 of file attribute.h.

◆ AttributeFloat3Array

TypedAttribute< Vector3fArray > Ufe::AttributeFloat3Array

Specialized typed attribute for an array of 3 float (vector) values.

Definition at line 468 of file attribute.h.

◆ AttributeFloat4

TypedAttribute< Vector4f > Ufe::AttributeFloat4

Specialized typed attribute for 4 float (vector) values.

Definition at line 404 of file attribute.h.

◆ AttributeFloat4Array

TypedAttribute< Vector4fArray > Ufe::AttributeFloat4Array

Specialized typed attribute for an array 4 float (vector) values.

Definition at line 480 of file attribute.h.

◆ AttributeFloatArray

TypedAttribute< FloatArray > Ufe::AttributeFloatArray

Specialized typed attribute for an array of float values.

Definition at line 440 of file attribute.h.

◆ AttributeInt

TypedAttribute< int > Ufe::AttributeInt

Specialized typed attribute for integer values.

Definition at line 364 of file attribute.h.

◆ AttributeInt2Array

TypedAttribute< Vector2iArray > Ufe::AttributeInt2Array

Specialized typed attribute for an array of 2 integer (vector) values.

Definition at line 452 of file attribute.h.

◆ AttributeInt3

TypedAttribute< Vector3i > Ufe::AttributeInt3

Specialized typed attribute for 3 integer (vector) values.

Definition at line 392 of file attribute.h.

◆ AttributeInt3Array

TypedAttribute< Vector3iArray > Ufe::AttributeInt3Array

Specialized typed attribute for an array of 3 integer (vector) values.

Definition at line 464 of file attribute.h.

◆ AttributeInt4Array

TypedAttribute< Vector4iArray > Ufe::AttributeInt4Array

Specialized typed attribute for an array 4 integer (vector) values.

Definition at line 476 of file attribute.h.

◆ AttributeIntArray

TypedAttribute< IntArray > Ufe::AttributeIntArray

Specialized typed attribute for an array of integer values.

Definition at line 432 of file attribute.h.

◆ AttributeMatrix3d

TypedAttribute< Matrix3d > Ufe::AttributeMatrix3d

Specialized typed attribute for 3x3 double (matrix) values.

Matrices are defined to be in row-major order, so matrix[i][j] indexes the element in the i th row and the j th column.

Definition at line 416 of file attribute.h.

◆ AttributeMatrix4d

TypedAttribute< Matrix4d > Ufe::AttributeMatrix4d

Specialized typed attribute for 4x4 double (matrix) values.

Matrices are defined to be in row-major order, so matrix[i][j] indexes the element in the i th row and the j th column.

Definition at line 424 of file attribute.h.

◆ AttributeMatrixDouble3Array

TypedAttribute< Matrix3dArray > Ufe::AttributeMatrixDouble3Array

Specialized typed attribute for an array 3 double (matrix) values.

Definition at line 496 of file attribute.h.

◆ AttributeMatrixDouble4Array

TypedAttribute< Matrix4dArray > Ufe::AttributeMatrixDouble4Array

Specialized typed attribute for an array of 4 double (matrix) values.

Definition at line 500 of file attribute.h.

◆ AttributeString

TypedAttribute< std::string > Ufe::AttributeString

Specialized typed attribute for string values.

Definition at line 380 of file attribute.h.

◆ AttributeStringArray

TypedAttribute< StringArray > Ufe::AttributeStringArray

Specialized typed attribute for an array of string values.

Definition at line 448 of file attribute.h.

◆ AttributeUInt

TypedAttribute< unsigned int > Ufe::AttributeUInt

Specialized typed attribute for integer values.

Definition at line 368 of file attribute.h.

◆ AttributeUIntArray

TypedAttribute< UIntArray > Ufe::AttributeUIntArray

Specialized typed attribute for an array of unsigned integer values.

Definition at line 436 of file attribute.h.

◆ BoolArray

typedef Array<bool> Ufe::BoolArray

Definition at line 404 of file array.h.

◆ Color3f

typedef TypedColorN<float, 3> Ufe::Color3f

Definition at line 235 of file types.h.

◆ Color3fArray

typedef Array<Color3f> Ufe::Color3fArray

Definition at line 419 of file array.h.

◆ Color4f

typedef TypedColorN<float, 4> Ufe::Color4f

Definition at line 236 of file types.h.

◆ Color4fArray

typedef Array<Color4f> Ufe::Color4fArray

Definition at line 420 of file array.h.

◆ ConstAttributeDefs

typedef std::vector<AttributeDef::ConstPtr> Ufe::ConstAttributeDefs

Definition at line 26 of file nodeDef.h.

◆ DoubleArray

typedef Array<double> Ufe::DoubleArray

Definition at line 408 of file array.h.

◆ FarClipPlaneUndoableCommand

typedef SetFloatUndoableCommand Ufe::FarClipPlaneUndoableCommand

Definition at line 27 of file cameraUndoableCommands.h.

◆ FloatArray

typedef Array<float> Ufe::FloatArray

Definition at line 407 of file array.h.

◆ FocalLengthUndoableCommand

typedef SetFloatUndoableCommand Ufe::FocalLengthUndoableCommand

Definition at line 24 of file cameraUndoableCommands.h.

◆ FocusDistanceUndoableCommand

typedef SetFloatUndoableCommand Ufe::FocusDistanceUndoableCommand

Definition at line 25 of file cameraUndoableCommands.h.

◆ FStopUndoableCommand

typedef SetFloatUndoableCommand Ufe::FStopUndoableCommand

Definition at line 23 of file cameraUndoableCommands.h.

◆ HorizontalApertureOffsetUndoableCommand

typedef SetFloatUndoableCommand Ufe::HorizontalApertureOffsetUndoableCommand

Definition at line 21 of file cameraUndoableCommands.h.

◆ HorizontalApertureUndoableCommand

typedef SetFloatUndoableCommand Ufe::HorizontalApertureUndoableCommand

Definition at line 19 of file cameraUndoableCommands.h.

◆ IntArray

typedef Array<int> Ufe::IntArray

Definition at line 405 of file array.h.

◆ Matrix3d

typedef TypedSquareMatrixN<double, 3> Ufe::Matrix3d

Definition at line 314 of file types.h.

◆ Matrix3dArray

typedef Array<Matrix3d> Ufe::Matrix3dArray

Definition at line 421 of file array.h.

◆ Matrix4d

typedef TypedSquareMatrixN<double, 4> Ufe::Matrix4d

Definition at line 315 of file types.h.

◆ Matrix4dArray

typedef Array<Matrix4d> Ufe::Matrix4dArray

Definition at line 422 of file array.h.

◆ NearClipPlaneUndoableCommand

typedef SetFloatUndoableCommand Ufe::NearClipPlaneUndoableCommand

Definition at line 26 of file cameraUndoableCommands.h.

◆ NodeDefs

typedef std::vector<NodeDef::Ptr> Ufe::NodeDefs

Definition at line 141 of file nodeDef.h.

◆ ProjectionUndoableCommand

typedef SetIntUndoableCommand Ufe::ProjectionUndoableCommand

Definition at line 28 of file cameraUndoableCommands.h.

◆ RenameAttributeUndoableCommand

typedef AttributeUndoableCommand Ufe::RenameAttributeUndoableCommand

Definition at line 18 of file attributesUndoableCommands.h.

◆ RotateUndoableCommand

typedef SetVector3dUndoableCommand Ufe::RotateUndoableCommand

Definition at line 19 of file transform3dUndoableCommands.h.

◆ Rtid

typedef uint32_t Ufe::Rtid

Definition at line 27 of file rtid.h.

◆ ScaleUndoableCommand

typedef SetVector3dUndoableCommand Ufe::ScaleUndoableCommand

Definition at line 20 of file transform3dUndoableCommands.h.

◆ SceneItemList

typedef std::list<std::shared_ptr<SceneItem> > Ufe::SceneItemList

Definition at line 22 of file sceneItemList.h.

◆ SceneItemPtr

using Ufe::SceneItemPtr = typedef std::shared_ptr<SceneItem>

Definition at line 22 of file ufeFwd.h.

◆ SelectionTrie

typedef Trie<Ufe::SceneItemList::iterator> Ufe::SelectionTrie

Definition at line 18 of file selectionTrieFwd.h.

◆ SetBoolUndoableCommand

using Ufe::SetBoolUndoableCommand = typedef SetValueUndoableCommand<bool>

Definition at line 148 of file baseUndoableCommands.h.

◆ SetColor3fUndoableCommand

using Ufe::SetColor3fUndoableCommand = typedef SetValueUndoableCommand<const Color3f &>

Definition at line 154 of file baseUndoableCommands.h.

◆ SetColor4fUndoableCommand

using Ufe::SetColor4fUndoableCommand = typedef SetValueUndoableCommand<const Color4f &>

Definition at line 155 of file baseUndoableCommands.h.

◆ SetDoubleUndoableCommand

using Ufe::SetDoubleUndoableCommand = typedef SetValueUndoableCommand<double>

Definition at line 145 of file baseUndoableCommands.h.

◆ SetFloatUndoableCommand

using Ufe::SetFloatUndoableCommand = typedef SetValueUndoableCommand<float>

Definition at line 144 of file baseUndoableCommands.h.

◆ SetIntUndoableCommand

using Ufe::SetIntUndoableCommand = typedef SetValueUndoableCommand<int>

Definition at line 149 of file baseUndoableCommands.h.

◆ SetMatrix3dUndoableCommand

using Ufe::SetMatrix3dUndoableCommand = typedef SetValueUndoableCommand<const Matrix3d &>

Definition at line 146 of file baseUndoableCommands.h.

◆ SetMatrix4dUndoableCommand

using Ufe::SetMatrix4dUndoableCommand = typedef SetValueUndoableCommand<const Matrix4d &>

Definition at line 147 of file baseUndoableCommands.h.

◆ SetVector2fUndoableCommand

using Ufe::SetVector2fUndoableCommand = typedef SetValue2UndoableCommand<float>

Definition at line 150 of file baseUndoableCommands.h.

◆ SetVector3dUndoableCommand

using Ufe::SetVector3dUndoableCommand = typedef SetValue3UndoableCommand<double>

Definition at line 153 of file baseUndoableCommands.h.

◆ SetVector3fUndoableCommand

using Ufe::SetVector3fUndoableCommand = typedef SetValue3UndoableCommand<float>

Definition at line 151 of file baseUndoableCommands.h.

◆ SetVector4fUndoableCommand

using Ufe::SetVector4fUndoableCommand = typedef SetValue4UndoableCommand<float>

Definition at line 152 of file baseUndoableCommands.h.

◆ ShearUndoableCommand

typedef SetVector3dUndoableCommand Ufe::ShearUndoableCommand

Definition at line 21 of file transform3dUndoableCommands.h.

◆ StringArray

typedef Array<std::string> Ufe::StringArray

Definition at line 409 of file array.h.

◆ TranslateUndoableCommand

typedef SetVector3dUndoableCommand Ufe::TranslateUndoableCommand

Definition at line 18 of file transform3dUndoableCommands.h.

◆ UIntArray

typedef Array<unsigned int> Ufe::UIntArray

Definition at line 406 of file array.h.

◆ UndoableCommandPtr

using Ufe::UndoableCommandPtr = typedef std::shared_ptr<UndoableCommand>

Definition at line 23 of file ufeFwd.h.

◆ ValueDictionary

using Ufe::ValueDictionary = typedef std::unordered_map<std::string, Value>

Definition at line 173 of file value.h.

◆ Vector2d

typedef TypedVectorN<double, 2> Ufe::Vector2d

Definition at line 143 of file types.h.

◆ Vector2dArray

typedef Array<Vector2d> Ufe::Vector2dArray

Definition at line 412 of file array.h.

◆ Vector2f

typedef TypedVectorN<float, 2> Ufe::Vector2f

Definition at line 142 of file types.h.

◆ Vector2fArray

typedef Array<Vector2f> Ufe::Vector2fArray

Definition at line 411 of file array.h.

◆ Vector2i

typedef TypedVectorN<int, 2> Ufe::Vector2i

Definition at line 141 of file types.h.

◆ Vector2iArray

typedef Array<Vector2i> Ufe::Vector2iArray

Definition at line 410 of file array.h.

◆ Vector3d

typedef TypedVectorN<double, 3> Ufe::Vector3d

Definition at line 146 of file types.h.

◆ Vector3dArray

typedef Array<Vector3d> Ufe::Vector3dArray

Definition at line 415 of file array.h.

◆ Vector3f

typedef TypedVectorN<float, 3> Ufe::Vector3f

Definition at line 145 of file types.h.

◆ Vector3fArray

typedef Array<Vector3f> Ufe::Vector3fArray

Definition at line 414 of file array.h.

◆ Vector3i

typedef TypedVectorN<int, 3> Ufe::Vector3i

Definition at line 144 of file types.h.

◆ Vector3iArray

typedef Array<Vector3i> Ufe::Vector3iArray

Definition at line 413 of file array.h.

◆ Vector4d

typedef TypedVectorN<double, 4> Ufe::Vector4d

Definition at line 149 of file types.h.

◆ Vector4dArray

typedef Array<Vector4d> Ufe::Vector4dArray

Definition at line 418 of file array.h.

◆ Vector4f

typedef TypedVectorN<float, 4> Ufe::Vector4f

Definition at line 148 of file types.h.

◆ Vector4fArray

typedef Array<Vector4f> Ufe::Vector4fArray

Definition at line 417 of file array.h.

◆ Vector4i

typedef TypedVectorN<int, 4> Ufe::Vector4i

Definition at line 147 of file types.h.

◆ Vector4iArray

typedef Array<Vector4i> Ufe::Vector4iArray

Definition at line 416 of file array.h.

◆ VerticalApertureOffsetUndoableCommand

typedef SetFloatUndoableCommand Ufe::VerticalApertureOffsetUndoableCommand

Definition at line 22 of file cameraUndoableCommands.h.

◆ VerticalApertureUndoableCommand

typedef SetFloatUndoableCommand Ufe::VerticalApertureUndoableCommand

Definition at line 20 of file cameraUndoableCommands.h.

Function Documentation

◆ endsWith()

bool Ufe::endsWith	(	const std::string &	str,
		const std::string &	suffix
	)

Returns true if the argument string ends with the suffix string.

Parameters

[in]	str	argument string.
[in]	suffix	suffix string.

Returns: true if str ends with suffix.

◆ getAttributesFromRaw()

Attributes::Ptr Ufe::getAttributesFromRaw ( uint64_t raw )

◆ getRawAddress() [1/2]

uint64_t Ufe::getRawAddress ( const Attributes::Ptr & item )

◆ getRawAddress() [2/2]

uint64_t Ufe::getRawAddress ( const SceneItem::Ptr & item )

◆ getSceneItemFromRaw()

SceneItem::Ptr Ufe::getSceneItemFromRaw ( uint64_t raw )

◆ handleAssert()

void Ufe::handleAssert	(	const char *	func,
		const char *	filename,
		int	lineno,
		const char *	expr,
		const char *	msg
	)

◆ log()

void Ufe::log	(	const char *	func,
		const char *	filename,
		int	lineno,
		const std::string &	msg
	)

◆ lstrip()

std::string Ufe::lstrip	(	std::string	src,
		char	toStrip
	)

We need to export these functions to be able to run our unit tests, although this header file is not exposed with the other public header files.

Return a copy of the string with the leading toStrip character removed. If toStrip is '\0', the src argument is returned unchanged.

Parameters

[in]	src	string to be stripped.
[in]	toStrip	character to be stripped from the beginning of src.

Returns: Copy of src with leading toStrip removed.

◆ operator<<() [1/9]

std::ostream & Ufe::operator<<	(	std::ostream &	os,
		const BBox3d &	bbox
	)

Definition at line 63 of file debugTypesOstream.h.

References Ufe::BBox3d::max, Ufe::BBox3d::min, Ufe::TypedVectorN< T, SZ >::x(), Ufe::TypedVectorN< T, SZ >::y(), and Ufe::TypedVectorN< T, SZ >::z().

Here is the call graph for this function:

◆ operator<<() [2/9]

std::ostream & Ufe::operator<<	(	std::ostream &	os,
		const Matrix3d &	m
	)

Definition at line 42 of file debugTypesOstream.h.

References Ufe::TypedSquareMatrixN< T, SZ >::matrix.

◆ operator<<() [3/9]

std::ostream & Ufe::operator<<	(	std::ostream &	os,
		const Matrix4d &	m
	)

Definition at line 52 of file debugTypesOstream.h.

References Ufe::TypedSquareMatrixN< T, SZ >::matrix.

◆ operator<<() [4/9]

template<typename T , std::size_t SZ>

std::ostream & Ufe::operator<<	(	std::ostream &	os,
		const TypedColorN< T, SZ > &	c
	)

◆ operator<<() [5/9]

template<typename T , std::size_t SZ>

std::ostream & Ufe::operator<<	(	std::ostream &	os,
		const TypedSquareMatrixN< T, SZ > &	m
	)

◆ operator<<() [6/9]

template<class T >

std::ostream & Ufe::operator<<	(	std::ostream &	os,
		const TypedVectorN< T, 2 > &	v
	)

Definition at line 22 of file debugTypesOstream.h.

References Ufe::TypedVectorN< T, SZ >::x(), and Ufe::TypedVectorN< T, SZ >::y().

Here is the call graph for this function:

◆ operator<<() [7/9]

template<class T >

std::ostream & Ufe::operator<<	(	std::ostream &	os,
		const TypedVectorN< T, 3 > &	v
	)

Definition at line 29 of file debugTypesOstream.h.

References Ufe::TypedVectorN< T, SZ >::x(), Ufe::TypedVectorN< T, SZ >::y(), and Ufe::TypedVectorN< T, SZ >::z().

Here is the call graph for this function:

◆ operator<<() [8/9]

template<class T >

std::ostream & Ufe::operator<<	(	std::ostream &	os,
		const TypedVectorN< T, 4 > &	v
	)

Definition at line 36 of file debugTypesOstream.h.

References Ufe::TypedVectorN< T, SZ >::w(), Ufe::TypedVectorN< T, SZ >::x(), Ufe::TypedVectorN< T, SZ >::y(), and Ufe::TypedVectorN< T, SZ >::z().

Here is the call graph for this function:

◆ operator<<() [9/9]

template<typename T , std::size_t SZ>

std::ostream & Ufe::operator<<	(	std::ostream &	os,
		const TypedVectorN< T, SZ > &	v
	)

◆ operator>>() [1/3]

template<typename T , std::size_t SZ>

std::istream & Ufe::operator>>	(	std::istream &	is,
		TypedColorN< T, SZ > &	c
	)

◆ operator>>() [2/3]

template<typename T , std::size_t SZ>

std::istream & Ufe::operator>>	(	std::istream &	is,
		TypedSquareMatrixN< T, SZ > &	m
	)

◆ operator>>() [3/3]

template<typename T , std::size_t SZ>

std::istream & Ufe::operator>>	(	std::istream &	is,
		TypedVectorN< T, SZ > &	v
	)

◆ split() [1/2]

std::vector< std::string > Ufe::split	(	const std::string &	src,
		char	sep
	)

Split src into separate strings. If sep is '\0', a single-element vector with the src argument is returned.

Parameters

[in]	src	string to be split.
[in]	sep	separator character.

Returns: src split on sep into separate strings.

◆ split() [2/2]

std::vector< std::string > Ufe::split	(	const std::string &	src,
		const std::string &	sep
	)

Split src into separate strings, using a separator string. If the separator is an empty string, a single-element vector with the src argument is returned.

Parameters

[in]	src	string to be split.
[in]	sep	separator string.

Returns: src split on sep into separate strings.

Namespaces

Classes

Typedefs

Functions

Typedef Documentation

◆ AddAttributeUndoableCommand

◆ AttributeBool

◆ AttributeBoolArray

◆ AttributeColorFloat3

◆ AttributeColorFloat3Array

◆ AttributeColorFloat4

◆ AttributeColorFloat4Array

◆ AttributeDouble

◆ AttributeDouble2Array

◆ AttributeDouble3

◆ AttributeDouble3Array

◆ AttributeDouble4Array

◆ AttributeDoubleArray

◆ AttributeFloat

◆ AttributeFloat2

◆ AttributeFloat2Array

◆ AttributeFloat3

◆ AttributeFloat3Array

◆ AttributeFloat4

◆ AttributeFloat4Array

◆ AttributeFloatArray

◆ AttributeInt

◆ AttributeInt2Array

◆ AttributeInt3

◆ AttributeInt3Array

◆ AttributeInt4Array

◆ AttributeIntArray

◆ AttributeMatrix3d

◆ AttributeMatrix4d

◆ AttributeMatrixDouble3Array

◆ AttributeMatrixDouble4Array

◆ AttributeString

◆ AttributeStringArray

◆ AttributeUInt

◆ AttributeUIntArray

◆ BoolArray

◆ Color3f

◆ Color3fArray

◆ Color4f

◆ Color4fArray

◆ ConstAttributeDefs

◆ DoubleArray

◆ FarClipPlaneUndoableCommand

◆ FloatArray

◆ FocalLengthUndoableCommand

◆ FocusDistanceUndoableCommand

◆ FStopUndoableCommand

◆ HorizontalApertureOffsetUndoableCommand

◆ HorizontalApertureUndoableCommand

◆ IntArray

◆ Matrix3d

◆ Matrix3dArray

◆ Matrix4d

◆ Matrix4dArray

◆ NearClipPlaneUndoableCommand

◆ NodeDefs

◆ ProjectionUndoableCommand

◆ RenameAttributeUndoableCommand

◆ RotateUndoableCommand

◆ Rtid

◆ ScaleUndoableCommand

◆ SceneItemList

◆ SceneItemPtr

◆ SelectionTrie

◆ SetBoolUndoableCommand

◆ SetColor3fUndoableCommand

◆ SetColor4fUndoableCommand

◆ SetDoubleUndoableCommand

◆ SetFloatUndoableCommand

◆ SetIntUndoableCommand

◆ SetMatrix3dUndoableCommand

◆ SetMatrix4dUndoableCommand

◆ SetVector2fUndoableCommand

◆ SetVector3dUndoableCommand

◆ SetVector3fUndoableCommand