< Home

< Table of Contents

REFERENCE MANUAL

Exchange::Factory Class Reference

#include <sprk_exchange.h>

Inheritance diagram for Exchange::Factory:
Sprocket Object

Static Public Member Functions

static CADModel CreateCADModel (Model const &in_model=Factory::CreateModel(), A3DAsmModelFile *in_entity=nullptr, bool in_owns_entity=false)
 
static Capture CreateCapture (Component const &in_owner, A3DEntity *in_entity=nullptr, bool in_is_default=false)
 
static Component CreateComponent (Component const &in_owner, Component::ComponentType in_type, A3DEntity *in_entity=nullptr)
 
static Filter CreateFilter (Component const &in_owner, A3DEntity *in_entity=nullptr)
 
static Sheet CreateSheet (Component const &in_owner, A3DEntity *in_entity=nullptr)
 
- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 

Additional Inherited Members

- Public Types inherited from Sprocket
enum  UpdateType { Synchronous, Asynchronous }
 
- Public Member Functions inherited from Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
virtual Type ObjectType () const
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Detailed Description

The Factory class is used to create and Exchange objects which inherit from Component or one of its subclasses.

Member Function Documentation

static CADModel Exchange::Factory::CreateCADModel ( Model const &  in_model = Factory::CreateModel(),
A3DAsmModelFile *  in_entity = nullptr,
bool  in_owns_entity = false 
)
static

Creates a new Exchange::CADModel.

Parameters
in_modelThe Model associated with the newly created Exchange::CADModel.
in_entityThe Exchange entity associated with the newly created Exchange::CADModel.
in_owns_entityWhether the newly created Exchange::CADModel owns the associated A3DAsmModelFile (see the documentation for Exchange::CADModel::GetEntityOwnership for more details).
static Capture Exchange::Factory::CreateCapture ( Component const &  in_owner,
A3DEntity *  in_entity = nullptr,
bool  in_is_default = false 
)
static

Creates a new Exchange::Capture as a subcomponent of a given Component.

Parameters
in_ownerThe Component which owns the newly created Exchange::Capture.
in_entityThe Exchange entity associated with the newly created Exchange::Capture.
in_is_defaultWhether the newly created Exchange::Capture is the default capture for the CADModel, i.e., the capture that will be activated when CADModel::ActivateDefaultCapture is invoked. Note that if one is creating a default capture, the owner must be a CADModel (or subclass thereof) and this will delete the old default capture on that CADModel if one was present.
static Component Exchange::Factory::CreateComponent ( Component const &  in_owner,
Component::ComponentType  in_type,
A3DEntity *  in_entity = nullptr 
)
static

Creates a new Exchange::Component as a subcomponent of a given Component.

Parameters
in_ownerThe Component which owns the newly created Exchange::Component.
in_typeThe type of Exchange::Component to create.
in_entityThe Exchange entity associated with the newly created Exchange::Component.
static Filter Exchange::Factory::CreateFilter ( Component const &  in_owner,
A3DEntity *  in_entity = nullptr 
)
static

Creates a new Exchange::Filter as a subcomponent of a given Component.

Parameters
in_ownerThe Component which owns the newly created Exchange::Filter.
in_entityThe Exchange entity associated with the newly created Exchange::Filter.
static Sheet Exchange::Factory::CreateSheet ( Component const &  in_owner,
A3DEntity *  in_entity = nullptr 
)
static

Creates a new Exchange::Sheet as a subcomponent of a given Component.

Parameters
in_ownerThe Component which owns the newly created Exchange::Sheet.
in_entityThe Exchange entity associated with the newly created Exchange::Sheet.

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