Om  1.0.0
A universal framework for multimedia simulation
Classes | Public Member Functions | List of all members
om::editors::types::SequencerEditor Class Reference

A class that edits an object of the Sequencer type. More...

#include <omSequencerEditor.h>

Inheritance diagram for om::editors::types::SequencerEditor:
om::editors::base::ResourceTypeEditor

Classes

class  Factory
 
class  View
 

Public Member Functions

 SequencerEditor (Sequencer *newSequencer, ResourceID *newSequencerID, const EditorServices &services)
 Create a new sequencer editor for the specified sequencer. More...
 
virtual OpaqueResource getResource () const
 Return an opaque pointer to the resource that is currently being edited. More...
 
virtual const ResourceTypegetResourceType () const
 Return the resource type that this editor is able to edit. More...
 
virtual GUIImage getResourceIcon (const Vector2f &size) const
 Return an image that represents the icon for the edited resource. More...
 
virtual om::graphics::gui::GUIObjectgetMainView () const
 Return a pointer to a GUI object that should be used as the main view for this editor. More...
 
virtual om::graphics::gui::GUIObjectgetMiniView () const
 Return a pointer to a GUI object that should be used as the mini view for this editor. More...
 
virtual void editedResource (const OpaqueResource &resource)
 A method that should be called when a resource used by the prototype was edited. More...
 
- Public Member Functions inherited from om::editors::base::ResourceTypeEditor
 ResourceTypeEditor ()
 Create a new resource type editor that has no resource set. More...
 
 ResourceTypeEditor (const EditorServices &newServices)
 Create a new resource type editor that uses the specified resource set. More...
 
virtual ~ResourceTypeEditor ()
 Destroy this resource type editor and release all internal resources. More...
 
OM_INLINE const EditorServicesgetServices () const
 Return a reference to the external services for this resource type editor. More...
 
virtual void setServices (const EditorServices &newServices)
 Set the external services for this resource type editor. More...
 
OM_INLINE const DelegategetDelegate () const
 Return a reference to the delegate for this resource type editor. More...
 
virtual void setDelegate (const Delegate &newDelegate)
 Set the delegate for this resource type editor. More...
 
virtual Bool getSelectedResource (OpaqueResource &resource) const
 Get an opaque reference to the currently selected resource in the editor. More...
 
virtual Size getInputCount () const
 Return the number of input data connections there are for this editor's resource. More...
 
virtual Size getOutputCount () const
 Return the number of output data connections there are for this editor's resource. More...
 
virtual const ResourceTypegetInputType (Index inputIndex) const
 Return the resource type of the input data connection for this editor's resource at the specified index. More...
 
virtual const ResourceTypegetOutputType (Index outputIndex) const
 Return the resource type of the output data connection for this editor's resource at the specified index. More...
 
virtual UTF8String getInputName (Index inputIndex) const
 Return the name of the input data connection for this editor's resource at the specified index. More...
 
virtual UTF8String getOutputName (Index outputIndex) const
 Return the name of the output data connection for this editor's resource at the specified index. More...
 
virtual GUIImage getInputIcon (Index inputIndex, const Vector2f &size) const
 Return the icon of the input data connection for this editor's resource at the specified index. More...
 
virtual GUIImage getOutputIcon (Index outputIndex, const Vector2f &size) const
 Return the icon of the output data connection for this editor's resource at the specified index. More...
 
virtual OpaqueResource newInputConnection (Index inputIndex) const
 Construct and return a pointer to a new input connection at the specified index. More...
 
virtual OpaqueResource newOutputConnection (Index outputIndex) const
 Construct and return a pointer to a new output connection at the specified index. More...
 
virtual OpaqueResource newInputConnector (Index inputIndex, const OpaqueResource &connection) const
 Construct and return a pointer to a new input connector at the specified index. More...
 
virtual OpaqueResource newOutputConnector (Index outputIndex, const OpaqueResource &connection) const
 Construct and return a pointer to a new output connector at the specified index. More...
 

Additional Inherited Members

- Protected Attributes inherited from om::editors::base::ResourceTypeEditor
EditorServices services
 An object that contains the external services for this editor. More...
 
Delegate delegate
 An object that responds to events for this resource type editor. More...
 

Detailed Description

A class that edits an object of the Sequencer type.

Constructor & Destructor Documentation

om::editors::types::SequencerEditor::SequencerEditor ( Sequencer *  newSequencer,
ResourceID newSequencerID,
const EditorServices services 
)

Create a new sequencer editor for the specified sequencer.

Member Function Documentation

virtual OpaqueResource om::editors::types::SequencerEditor::getResource ( ) const
virtual

Return an opaque pointer to the resource that is currently being edited.

Implements om::editors::base::ResourceTypeEditor.

virtual const ResourceType& om::editors::types::SequencerEditor::getResourceType ( ) const
virtual

Return the resource type that this editor is able to edit.

Implements om::editors::base::ResourceTypeEditor.

virtual GUIImage om::editors::types::SequencerEditor::getResourceIcon ( const Vector2f &  size) const
virtual

Return an image that represents the icon for the edited resource.

Implements om::editors::base::ResourceTypeEditor.

virtual om::graphics::gui::GUIObject* om::editors::types::SequencerEditor::getMainView ( ) const
virtual

Return a pointer to a GUI object that should be used as the main view for this editor.

Implements om::editors::base::ResourceTypeEditor.

virtual om::graphics::gui::GUIObject* om::editors::types::SequencerEditor::getMiniView ( ) const
virtual

Return a pointer to a GUI object that should be used as the mini view for this editor.

Reimplemented from om::editors::base::ResourceTypeEditor.

virtual void om::editors::types::SequencerEditor::editedResource ( const OpaqueResource resource)
virtual

A method that should be called when a resource used by the prototype was edited.

Reimplemented from om::editors::base::ResourceTypeEditor.


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