k3d::detail::public_document_implementation Class Reference

Encapsulates an open K-3D document. More...

Inheritance diagram for k3d::detail::public_document_implementation:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 public_document_implementation (istate_recorder &StateRecorder, inode_collection &Nodes, ipipeline &Pipeline)
 ~public_document_implementation ()
idocumentdocument ()
inode_collectionnodes ()
 Returns the collection of K-3D objects within this document.
ipipelinepipeline ()
 Returns the directed acyclic graph of dependencies between object properties within this document.
ipipeline_profilerpipeline_profiler ()
 Returns an object that can be used to collect and distribute profiling data for the visualization pipeline.
istate_recorderstate_recorder ()
 Returns the istate_recorder interface for this document.
inode_name_mapunique_node_names ()
 Returns an interface that provides a mapping of nodes to unique names.
ipropertypath ()
 Returns a property that will store the document filepath (could be empty).
ipropertytitle ()
 Returns a property that will store the document title (could be empty string).
idocument::close_signal_tclose_signal ()

Private Member Functions

 k3d_data (filesystem::path, immutable_name, change_signal, no_undo, local_storage, no_constraint, writable_property, no_serialization) m_path
 Stores the full document filepath (if any).
 k3d_data (ustring, immutable_name, change_signal, no_undo, local_storage, no_constraint, writable_property, no_serialization) m_title
 Stores the document title (if any).

Private Attributes

close_signal_t m_close_signal
 Notifies observers that the document is being closed.
istate_recorderm_state_recorder
 Records changes made by the user for Undo / Redo purposes.
inode_collectionm_nodes
 Stores document nodes ...
ipipelinem_pipeline
 Stores a reference to an implementation of ipipeline.
k3d::pipeline_profiler m_pipeline_profiler
 Stores a pipeline profiler object.
node_name_map m_unique_node_names
 Stores unique node names.

Detailed Description

Encapsulates an open K-3D document.


Constructor & Destructor Documentation

k3d::detail::public_document_implementation::public_document_implementation ( istate_recorder StateRecorder,
inode_collection Nodes,
ipipeline Pipeline 
) [inline]
k3d::detail::public_document_implementation::~public_document_implementation (  )  [inline]

Member Function Documentation

idocument::close_signal_t& k3d::detail::public_document_implementation::close_signal (  )  [inline, virtual]

Implements k3d::idocument.

References m_close_signal.

idocument& k3d::detail::public_document_implementation::document (  )  [inline]
k3d::detail::public_document_implementation::k3d_data ( ustring  ,
immutable_name  ,
change_signal  ,
no_undo  ,
local_storage  ,
no_constraint  ,
writable_property  ,
no_serialization   
) [private]

Stores the document title (if any).

k3d::detail::public_document_implementation::k3d_data ( filesystem::path  ,
immutable_name  ,
change_signal  ,
no_undo  ,
local_storage  ,
no_constraint  ,
writable_property  ,
no_serialization   
) [private]

Stores the full document filepath (if any).

inode_collection& k3d::detail::public_document_implementation::nodes (  )  [inline, virtual]

Returns the collection of K-3D objects within this document.

Implements k3d::idocument.

References m_nodes.

iproperty& k3d::detail::public_document_implementation::path (  )  [inline, virtual]

Returns a property that will store the document filepath (could be empty).

Implements k3d::idocument.

ipipeline& k3d::detail::public_document_implementation::pipeline (  )  [inline, virtual]

Returns the directed acyclic graph of dependencies between object properties within this document.

Implements k3d::idocument.

References m_pipeline.

ipipeline_profiler& k3d::detail::public_document_implementation::pipeline_profiler (  )  [inline, virtual]

Returns an object that can be used to collect and distribute profiling data for the visualization pipeline.

Implements k3d::idocument.

References m_pipeline_profiler.

istate_recorder& k3d::detail::public_document_implementation::state_recorder (  )  [inline, virtual]

Returns the istate_recorder interface for this document.

Implements k3d::idocument.

References m_state_recorder.

iproperty& k3d::detail::public_document_implementation::title (  )  [inline, virtual]

Returns a property that will store the document title (could be empty string).

Implements k3d::idocument.

inode_name_map& k3d::detail::public_document_implementation::unique_node_names (  )  [inline, virtual]

Returns an interface that provides a mapping of nodes to unique names.

Implements k3d::idocument.

References m_unique_node_names.


Member Data Documentation

Notifies observers that the document is being closed.

Referenced by close_signal().

Stores a reference to an implementation of ipipeline.

Referenced by pipeline(), and k3d::detail::document_implementation::~document_implementation().

Stores a pipeline profiler object.

Referenced by pipeline_profiler().

Records changes made by the user for Undo / Redo purposes.

Referenced by state_recorder(), and k3d::detail::document_implementation::~document_implementation().

Stores unique node names.

Referenced by public_document_implementation(), and unique_node_names().


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

Generated on Mon Mar 21 07:42:20 2011 for K-3D by doxygen 1.6.3