ufe 5.5
Universal Front End is a DCC-agnostic component that will allow a DCC to browse and edit data in multiple data models
|
Namespaces | |
namespace | GlobalSelection |
namespace | NamedSelection |
namespace | PathString |
Classes | |
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 | 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 | Light_v5_5 |
Class for new light types. More... | |
class | LightChanged |
Base class for all Light notifications. More... | |
class | LightHandler |
Factory base class for Light interface. More... | |
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 |
class | VersionInfo |
Version information of UFE. More... | |
class | VisibilityChanged |
Visibility changed notification. More... | |
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) |
void | handleAssert (const char *func, const char *filename, int lineno, const char *expr, const char *msg) |
Definition at line 19 of file attributesUndoableCommands.h.
TypedAttribute< bool > Ufe::AttributeBool |
Specialized typed attribute for boolean values.
Definition at line 262 of file attribute.h.
Specialized typed attribute for color (3 float) values.
Definition at line 282 of file attribute.h.
Specialized typed attribute for color (4 float) values.
Definition at line 286 of file attribute.h.
TypedAttribute< double > Ufe::AttributeDouble |
Specialized typed attribute for double values.
Definition at line 274 of file attribute.h.
Specialized typed attribute for 3 double (vector) values.
Definition at line 306 of file attribute.h.
TypedAttribute< float > Ufe::AttributeFloat |
Specialized typed attribute for float values.
Definition at line 270 of file attribute.h.
Specialized typed attribute for 2 float (vector) values.
Definition at line 294 of file attribute.h.
Specialized typed attribute for 3 float (vector) values.
Definition at line 298 of file attribute.h.
Specialized typed attribute for 4 float (vector) values.
Definition at line 302 of file attribute.h.
TypedAttribute< int > Ufe::AttributeInt |
Specialized typed attribute for integer values.
Definition at line 266 of file attribute.h.
Specialized typed attribute for 3 integer (vector) values.
Definition at line 290 of file attribute.h.
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 314 of file attribute.h.
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 322 of file attribute.h.
TypedAttribute< std::string > Ufe::AttributeString |
Specialized typed attribute for string values.
Definition at line 278 of file attribute.h.
typedef TypedColorN<float, 3> Ufe::Color3f |
typedef TypedColorN<float, 4> Ufe::Color4f |
typedef std::vector<AttributeDef::ConstPtr> Ufe::ConstAttributeDefs |
Definition at line 26 of file cameraUndoableCommands.h.
Definition at line 23 of file cameraUndoableCommands.h.
Definition at line 24 of file cameraUndoableCommands.h.
Definition at line 22 of file cameraUndoableCommands.h.
Definition at line 20 of file cameraUndoableCommands.h.
Definition at line 18 of file cameraUndoableCommands.h.
typedef TypedSquareMatrixN<double, 3> Ufe::Matrix3d |
typedef TypedSquareMatrixN<double, 4> Ufe::Matrix4d |
Definition at line 25 of file cameraUndoableCommands.h.
typedef std::vector<NodeDef::Ptr> Ufe::NodeDefs |
Definition at line 27 of file cameraUndoableCommands.h.
Definition at line 20 of file attributesUndoableCommands.h.
Definition at line 18 of file transform3dUndoableCommands.h.
Definition at line 19 of file transform3dUndoableCommands.h.
typedef std::list<std::shared_ptr<SceneItem> > Ufe::SceneItemList |
Definition at line 21 of file sceneItemList.h.
using Ufe::SceneItemPtr = typedef std::shared_ptr<SceneItem> |
typedef Trie<Ufe::SceneItemList::iterator> Ufe::SelectionTrie |
Definition at line 19 of file selectionTrieFwd.h.
using Ufe::SetBoolUndoableCommand = typedef SetValueUndoableCommand<bool> |
Definition at line 139 of file baseUndoableCommands.h.
using Ufe::SetColor3fUndoableCommand = typedef SetValueUndoableCommand<const Color3f &> |
Definition at line 145 of file baseUndoableCommands.h.
using Ufe::SetColor4fUndoableCommand = typedef SetValueUndoableCommand<const Color4f &> |
Definition at line 146 of file baseUndoableCommands.h.
using Ufe::SetDoubleUndoableCommand = typedef SetValueUndoableCommand<double> |
Definition at line 136 of file baseUndoableCommands.h.
using Ufe::SetFloatUndoableCommand = typedef SetValueUndoableCommand<float> |
Definition at line 135 of file baseUndoableCommands.h.
using Ufe::SetIntUndoableCommand = typedef SetValueUndoableCommand<int> |
Definition at line 140 of file baseUndoableCommands.h.
using Ufe::SetMatrix3dUndoableCommand = typedef SetValueUndoableCommand<const Matrix3d &> |
Definition at line 137 of file baseUndoableCommands.h.
using Ufe::SetMatrix4dUndoableCommand = typedef SetValueUndoableCommand<const Matrix4d &> |
Definition at line 138 of file baseUndoableCommands.h.
using Ufe::SetVector2fUndoableCommand = typedef SetValue2UndoableCommand<float> |
Definition at line 141 of file baseUndoableCommands.h.
using Ufe::SetVector3dUndoableCommand = typedef SetValue3UndoableCommand<double> |
Definition at line 144 of file baseUndoableCommands.h.
using Ufe::SetVector3fUndoableCommand = typedef SetValue3UndoableCommand<float> |
Definition at line 142 of file baseUndoableCommands.h.
using Ufe::SetVector4fUndoableCommand = typedef SetValue4UndoableCommand<float> |
Definition at line 143 of file baseUndoableCommands.h.
Definition at line 20 of file transform3dUndoableCommands.h.
Definition at line 17 of file transform3dUndoableCommands.h.
using Ufe::UndoableCommandPtr = typedef std::shared_ptr<UndoableCommand> |
using Ufe::ValueDictionary = typedef std::unordered_map<std::string, Value> |
typedef TypedVectorN<double, 2> Ufe::Vector2d |
typedef TypedVectorN<float, 2> Ufe::Vector2f |
typedef TypedVectorN<int, 2> Ufe::Vector2i |
typedef TypedVectorN<double, 3> Ufe::Vector3d |
typedef TypedVectorN<float, 3> Ufe::Vector3f |
typedef TypedVectorN<int, 3> Ufe::Vector3i |
typedef TypedVectorN<double, 4> Ufe::Vector4d |
typedef TypedVectorN<float, 4> Ufe::Vector4f |
typedef TypedVectorN<int, 4> Ufe::Vector4i |
Definition at line 21 of file cameraUndoableCommands.h.
Definition at line 19 of file cameraUndoableCommands.h.
bool Ufe::endsWith | ( | const std::string & | str, |
const std::string & | suffix | ||
) |
Returns true if the argument string ends with the suffix string.
[in] | str | argument string. |
[in] | suffix | suffix string. |
Attributes::Ptr Ufe::getAttributesFromRaw | ( | uint64_t | raw | ) |
uint64_t Ufe::getRawAddress | ( | const Attributes::Ptr & | item | ) |
uint64_t Ufe::getRawAddress | ( | const SceneItem::Ptr & | item | ) |
SceneItem::Ptr Ufe::getSceneItemFromRaw | ( | uint64_t | raw | ) |
void Ufe::handleAssert | ( | const char * | func, |
const char * | filename, | ||
int | lineno, | ||
const char * | expr, | ||
const char * | msg | ||
) |
void Ufe::log | ( | const char * | func, |
const char * | filename, | ||
int | lineno, | ||
const std::string & | msg | ||
) |
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.
[in] | src | string to be stripped. |
[in] | toStrip | character to be stripped from the beginning of src. |
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().
std::ostream & Ufe::operator<< | ( | std::ostream & | os, |
const Matrix3d & | m | ||
) |
Definition at line 42 of file debugTypesOstream.h.
References Ufe::TypedSquareMatrixN< T, SZ >::matrix.
std::ostream & Ufe::operator<< | ( | std::ostream & | os, |
const Matrix4d & | m | ||
) |
Definition at line 52 of file debugTypesOstream.h.
References Ufe::TypedSquareMatrixN< T, SZ >::matrix.
std::ostream & Ufe::operator<< | ( | std::ostream & | os, |
const TypedColorN< T, SZ > & | c | ||
) |
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().
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().
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().
std::ostream & Ufe::operator<< | ( | std::ostream & | os, |
const TypedVectorN< T, SZ > & | v | ||
) |
std::istream & Ufe::operator>> | ( | std::istream & | is, |
TypedColorN< T, SZ > & | c | ||
) |
std::istream & Ufe::operator>> | ( | std::istream & | is, |
TypedVectorN< T, SZ > & | v | ||
) |
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.
[in] | src | string to be split. |
[in] | sep | separator character. |
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.
[in] | src | string to be split. |
[in] | sep | separator string. |