cadex::PMI::SavedView Class Reference

Defines a view orientation of the model and a subset of visible PMI elements. More...

#include <cadex/PMI/SavedView.hxx>

Inheritance diagram for cadex::PMI::SavedView:

Public Member Functions
	SavedView ()
	Constructor.
	SavedView (const Camera &theCamera)
	Constructor.
	SavedView (const Camera &theCamera, const UTF16String &theName)
	Constructor.
void	SetCamera (const Camera &theCamera)
	Sets the camera.
PMI::Camera	Camera () const
	Returns the camera.
void	SetName (const UTF16String &theName)
	Sets the name.
UTF16String	Name () const
	Returns the name.
void	AddElement (const Element &theElement)
	Adds the element.
const std::vector< PMI::Element > &	Elements () const
	Returns the elements.
size_t	NumberOfElements () const
	Returns the number of added elements.
Public Member Functions inherited from cadex::BaseObject
size_t	Id () const
	Return unique identifier of public object.
internal::BaseObjectImpl *	Impl () const
bool	IsNull () const
	operator bool () const
template<typename T >
bool	IsOfType () const
template<typename T >
T *	Impl () const
	Reserved for internal use.

Static Public Member Functions
static bool	CompareType (const BaseObject &theObject)
	Returns true if theObject has the SavedView type.

Protected Member Functions
	SavedView (const ImplType &theImpl)
Protected Member Functions inherited from cadex::BaseObject
	BaseObject (const ImplType &theImpl)

Additional Inherited Members
Public Types inherited from cadex::BaseObject
typedef std::shared_ptr< internal::BaseObjectImpl >	ImplType

Detailed Description

Defines a view orientation of the model and a subset of visible PMI elements.

A saved view facilitates presentation of the model and its annotation. It defines a set of elements that should be visible from the specific point of view.

A saved view contains graphical elements and camera.

Note

A saved view should have a name.

See also

Camera

Constructor & Destructor Documentation

SavedView() [1/3]

cadex::PMI::SavedView::SavedView

(

)

Constructor.

SavedView() [2/3]

cadex::PMI::SavedView::SavedView ( const Camera & theCamera )

explicit

Constructor.

SavedView() [3/3]

cadex::PMI::SavedView::SavedView	(	const Camera &	theCamera,
		const UTF16String &	theName )

Constructor.

Member Function Documentation

AddElement()

void cadex::PMI::SavedView::AddElement

(

const Element &

theElement

)

Adds the element.

Camera()

Camera cadex::PMI::SavedView::Camera

(

)

const

Returns the camera.

CompareType()

bool cadex::PMI::SavedView::CompareType ( const BaseObject & theObject )

static

Returns true if theObject has the SavedView type.

Elements()

const std::vector< PMI::Element > & cadex::PMI::SavedView::Elements

(

)

const

Returns the elements.

Name()

UTF16String cadex::PMI::SavedView::Name

(

)

const

Returns the name.

NumberOfElements()

size_t cadex::PMI::SavedView::NumberOfElements

(

)

const

Returns the number of added elements.

Returns 0 if IsNull().

SetCamera()

void cadex::PMI::SavedView::SetCamera

(

const Camera &

theCamera

)

Sets the camera.

SetName()

void cadex::PMI::SavedView::SetName

(

const UTF16String &

theName

)

Sets the name.