Dtk_View Class Reference

This is the view class. More...

Inheritance diagram for Dtk_View:

Public Types
enum	ViewType { NoTypeView = 0, DetailView = 1, SectionView = 2, BrokenView = 4 }

Public Member Functions
virtual Dtk_ErrorStatus	_Store (void *)
Dtk_ErrorStatus	Add2dEntities (const Dtk_tab< Dtk_2dEntityPtr > &in2DEntitiesArray)
	Adds an array of 2D entities to the view. More...
Dtk_ErrorStatus	Add2dEntity (const Dtk_2dEntityPtr &in2DEntity)
	Adds a 2D entity to the view. More...
Dtk_ErrorStatus	Add2dGeometricalEntity (const Dtk_EntityPtr &inGeomElt) const
	Adds a drawing geometrical entity to the view. More...
Dtk_ErrorStatus	AddBodies (Dtk_tab< Dtk_BodyPtr > inBodyArray)
	Adds an array of bodies displayed in the view. More...
Dtk_ErrorStatus	AddBody (const Dtk_BodyPtr &inBody)
	Adds a Body displayed in the view. More...
Dtk_ErrorStatus	AddEntities (const Dtk_tab< Dtk_EntityPtr > &inEntitiesArray)
	Adds an array of 2D entities, Dtk_Hatching, curve and point to the view ( other type are not supported ) More...
Dtk_ErrorStatus	AddEntity (const Dtk_EntityPtr &inEnt)
	Adds an entity, Dtk_Hatching, curve and point to the view ( other type are not supported ) More...
Dtk_ErrorStatus	AddOLEObject (const Dtk_OLEObjectPtr &inOLEObject)
	Adds a Dtk_OLEObjectPtr to the view. More...
Dtk_ErrorStatus	AddOLEObjects (const Dtk_tab< Dtk_OLEObjectPtr > &inOleObjects)
	Adds an array of Dtk_OLEObjectPtr to the view. More...
Dtk_ErrorStatus	AddPicture (const Dtk_picturePtr &inPicture)
	Adds a picture to the view. More...
Dtk_ErrorStatus	AddPictures (const Dtk_tab< Dtk_picturePtr > &inPicturesArray)
	Adds an array of pictures to the view. More...
void	AddView (ViewType typeView)
Dtk_Double64 &	Angle ()
	Retrieves the Dtk_View angle - get/set-. More...
const Dtk_Double64 &	Angle () const
	Retrieves the Dtk_View angle - read only -. More...
Dtk_Int32	DtkDynamicType (const Dtk_Int32 &inId)
	Retrieves the dynamic entity type. More...
int	DtkDynamicType (const int &inId)
virtual void	dump (FILE *file=stdout)
Dtk_2dEntityPtr	Get2dEntity (const Dtk_Size_t &inPos) const
	Retrieves the ith 2D entity. More...
Dtk_EntityPtr	Get2dGeometricalEntity (const Dtk_Size_t &inPos) const
	Retrieves the ith geometrical entity. More...
Dtk_InfoPtr	get_info () const
type_detk	get_type_detk () const
Dtk_BodyPtr	GetBody (const Dtk_Size_t &inPos) const
	Retrieves the ith Body. More...
Dtk_PlaneSurfacePtr	GetClipping (const Dtk_Size_t &inPos) const
const Dtk_CompositeEntityPtr &	GetClippingBoundary () const
const Dtk_ID &	GetID () const
	Get Internal UniqueID. More...
Dtk_Size_t	GetNum2dEntities () const
	Retrieves the 2D entities number - read only -. More...
Dtk_Size_t	GetNum2dGeometricalEntity () const
	Retrieves the number of geometrical entity to the view. More...
Dtk_Size_t	GetNumBodies () const
	Retrieves the bodies number to be dispalyed- read only -. More...
Dtk_Size_t	GetNumOLEObjects () const
	Retrieves the number of OLE Objects in the Dtk_View. More...
Dtk_Size_t	GetNumPictures () const
	Retrieves the pictures number - read only -. More...
Dtk_OLEObjectPtr	GetOLEObject (const Dtk_Size_t &inIndex) const
	Retrieves the OLE Object at index. More...
Dtk_picturePtr	GetPicture (const Dtk_Size_t &inPos) const
	Retrieves the ith Picture. More...
virtual Dtk_Size_t	GetSize () const
Dtk_ViewDisplayPtr	GetViewDisplay ()
	GetDisplayMode for 3D entity. More...
Dtk_InfoPtr &	info ()
bool	IsView (ViewType typeView)
Dtk_2dEntityPtr	operator[] (const Dtk_Size_t &inPos) const
	Retrieves the ith 2D entity. More...
virtual void	PrepareTransfo ()
Dtk_Double64 &	Scale ()
	Retrieves the Dtk_View scale - get/set-. More...
const Dtk_Double64 &	Scale () const
	Retrieves the Dtk_View scale - read only -. More...
void	SetClippingBoundary (const Dtk_CompositeEntityPtr &inBoundary) const
	Sets the clipping boundary informations. More...
Dtk_ErrorStatus	SetClippingPlane (const Dtk_Size_t &inPos, const Dtk_pnt &inLocation, const Dtk_dir &inRefAxis, const Dtk_dir &inNormalAxis)
	Sets the ith clipping plane informations. More...
void	SetViewDisplay (Dtk_ViewDisplayPtr inDisplay)
	SetDisplayMode for 3D entity to be displayed. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the entity. //! More...
Dtk_transfo &	TransformationMatrix ()
	Retrieves the Dtk_View transformation matrix - get/set-. More...
const Dtk_transfo &	TransformationMatrix () const
	Retrieves the Dtk_View transformation matrix - read only -. More...

Static Public Member Functions
static Dtk_ViewPtr	Create ()
	Calls default constructor to allocate a new object. More...
static Dtk_ViewPtr	Create (const Dtk_View &in)
	Calls copy constructor to allocate a new object. More...
static Dtk_ViewPtr	Create (Dtk_View &&in)
	Calls move constructor to allocate a new object. More...
static Dtk_View *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...

Protected Types
enum	{ _typeID = DTK_TYPE_OBJECT }
enum	{ _typeID = DTK_TYPE_ENTITY }
enum	{ _typeID = DTK_TYPE_VIEW }

Protected Member Functions
void	_copy (const Dtk_Entity &s)
void	_init ()
void	_reset ()
virtual Dtk_Object *	Clone ()
	Dtk_View ()
	Dtk_View (const Dtk_View &s)
	Dtk_View (Dtk_View &&s) DTK_NOEXCEPT
	~Dtk_View ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is the view class.

See also

Use Dtk_ViewPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_OBJECT }; 

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_ENTITY };

anonymous enum

anonymous enum

protected

Enumerator
_typeID

          {
          _typeID = DTK_TYPE_VIEW
     };

ViewType

enum Dtk_View::ViewType

Enumerator
NoTypeView
DetailView
SectionView
BrokenView

     {
          NoTypeView = 0,
          DetailView = 1,
          SectionView = 2,
          BrokenView = 4,
     };

Constructor & Destructor Documentation

Dtk_View() [1/3]

Dtk_View::Dtk_View ( )

protected

See also

Create()

Dtk_View() [2/3]

Dtk_View::Dtk_View ( const Dtk_View &  s )

protected

See also

Create(const Dtk_View&)

Dtk_View() [3/3]

Dtk_View::Dtk_View ( Dtk_View &&  s )

protected

See also

Create( Dtk_View&& )

~Dtk_View()

Dtk_View::~Dtk_View ( )

protected

Destructor.

Member Function Documentation

_copy()

void Dtk_Entity::_copy ( const Dtk_Entity &  s )

protectedinherited

_init()

void Dtk_Entity::_init ( )

protectedinherited

_reset()

void Dtk_Entity::_reset ( )

protectedinherited

_Store()

virtual Dtk_ErrorStatus Dtk_Entity::_Store ( void *  )

virtualinherited

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, and Dtk_Point.

Add2dEntities()

Dtk_ErrorStatus Dtk_View::Add2dEntities

(

const Dtk_tab< Dtk_2dEntityPtr > &

in2DEntitiesArray

)

Adds an array of 2D entities to the view.

Parameters

in2DEntitiesArray

Array of 2D entities to be added.

Returns

DtkNoError if OK.

Add2dEntity()

Dtk_ErrorStatus Dtk_View::Add2dEntity

(

const Dtk_2dEntityPtr &

in2DEntity

)

Adds a 2D entity to the view.

Parameters

in2DEntity

2D entity to be added.

Returns

DtkNoError if OK.

Add2dGeometricalEntity()

Dtk_ErrorStatus Dtk_View::Add2dGeometricalEntity

(

const Dtk_EntityPtr &

inGeomElt

)

const

Adds a drawing geometrical entity to the view.

Parameters

inGeomElt

geometrical entity to be added. only Dtk_pnt and Dtk_Curve are allowed

Returns

DtkNoError if OK. dtkErrorTypeNotsupported if entity isn't a Curve or a point

AddBodies()

Dtk_ErrorStatus Dtk_View::AddBodies

(

Dtk_tab< Dtk_BodyPtr >

inBodyArray

)

Adds an array of bodies displayed in the view.

Parameters

inBodyArray

Array of bodies to be displayed.

Returns

DtkNoError if OK.

AddBody()

Dtk_ErrorStatus Dtk_View::AddBody

(

const Dtk_BodyPtr &

inBody

)

Adds a Body displayed in the view.

Parameters

inBody

Body to be displayed.

Returns

DtkNoError if OK.

AddEntities()

Dtk_ErrorStatus Dtk_View::AddEntities

(

const Dtk_tab< Dtk_EntityPtr > &

inEntitiesArray

)

Adds an array of 2D entities, Dtk_Hatching, curve and point to the view ( other type are not supported )

Parameters

inEntitiesArray

Array of entities to be added.

Returns

DtkNoError if OK.

AddEntity()

Dtk_ErrorStatus Dtk_View::AddEntity

(

const Dtk_EntityPtr &

inEnt

)

Adds an entity, Dtk_Hatching, curve and point to the view ( other type are not supported )

Parameters

inEnt

Entity to be added.

Returns

DtkNoError if OK.

AddOLEObject()

Dtk_ErrorStatus Dtk_View::AddOLEObject

(

const Dtk_OLEObjectPtr &

inOLEObject

)

Adds a Dtk_OLEObjectPtr to the view.

Parameters

inOLEObject

Dtk_OLEObjectPtr to be added.

Returns

dtkNoError if OK.

AddOLEObjects()

Dtk_ErrorStatus Dtk_View::AddOLEObjects

(

const Dtk_tab< Dtk_OLEObjectPtr > &

inOleObjects

)

Adds an array of Dtk_OLEObjectPtr to the view.

Parameters

inOleObjects

Array of Dtk_OLEObjectPtr to be added.

Returns

dtkNoError if OK.

AddPicture()

Dtk_ErrorStatus Dtk_View::AddPicture

(

const Dtk_picturePtr &

inPicture

)

Adds a picture to the view.

Parameters

inPicture

Picture to be added.

Returns

dtkNoError if OK.

AddPictures()

Dtk_ErrorStatus Dtk_View::AddPictures

(

const Dtk_tab< Dtk_picturePtr > &

inPicturesArray

)

Adds an array of pictures to the view.

Parameters

inPicturesArray

Array of pictures to be added.

Returns

dtkNoError if OK.

AddView()

void Dtk_View::AddView

(

ViewType

typeView

)

Angle() [1/2]

Dtk_Double64& Dtk_View::Angle

(

)

Retrieves the Dtk_View angle - get/set-.

Returns

The Dtk_View angle.

See also

Angle() const

Angle() [2/2]

const Dtk_Double64& Dtk_View::Angle

(

)

const

Retrieves the Dtk_View angle - read only -.

Returns

The Dtk_View angle.

See also

Angle()

Clone()

virtual Dtk_Object* Dtk_View::Clone ( )

protectedvirtual

Implements Dtk_Entity.

{ return new Dtk_View(*this); }

Create() [1/3]

static Dtk_ViewPtr Dtk_View::Create ( )

static

Calls default constructor to allocate a new object.

Create() [2/3]

static Dtk_ViewPtr Dtk_View::Create ( const Dtk_View &  in )

static

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

Create() [3/3]

static Dtk_ViewPtr Dtk_View::Create ( Dtk_View &&  in )

static

Calls move constructor to allocate a new object.

Parameters

in	Object to move from.

DtkDynamicCast()

static Dtk_View* Dtk_View::DtkDynamicCast ( Dtk_Object *  s )

static

Performs a dynamic cast - doesn't need RTTI -.

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_View::DtkDynamicType

(

const Dtk_Int32 &

inId

)

Retrieves the dynamic entity type.

DtkDynamicType() [2/2]

int Dtk_Entity::DtkDynamicType ( const int &  inId )

virtualinherited

Implements Dtk_Object.

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, Dtk_MeshSurface, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Constraint, Dtk_ConstraintReference, and Dtk_AxisSystem.

dump()

virtual void Dtk_Object::dump ( FILE *  file = stdout )

virtualinherited

Get2dEntity()

Dtk_2dEntityPtr Dtk_View::Get2dEntity

(

const Dtk_Size_t &

inPos

)

const

Retrieves the ith 2D entity.

Parameters

inPos

2D entity index.

Returns

the inPos'th 2D entity.

Get2dGeometricalEntity()

Dtk_EntityPtr Dtk_View::Get2dGeometricalEntity

(

const Dtk_Size_t &

inPos

)

const

Retrieves the ith geometrical entity.

Parameters

inPos

geometrical entity index.

Returns

the inPos'th geometrical entity.

get_info()

Dtk_InfoPtr Dtk_Entity::get_info ( ) const

inherited

get_type_detk()

type_detk Dtk_View::get_type_detk ( ) const

virtual

Returns

The type of the entity type - DTK_TYPE_VIEW -

Implements Dtk_Entity.

     {
          return DTK_TYPE_VIEW;
     }

GetBody()

Dtk_BodyPtr Dtk_View::GetBody

(

const Dtk_Size_t &

inPos

)

const

Retrieves the ith Body.

Parameters

inPos

Body index.

Returns

the inPos'th Body.

GetClipping()

Dtk_PlaneSurfacePtr Dtk_View::GetClipping

(

const Dtk_Size_t &

inPos

)

const

Returns

The ith clipping

Parameters

inPos

clipping plane index.

Returns

the inPos'th clipping plane.

GetClippingBoundary()

const Dtk_CompositeEntityPtr& Dtk_View::GetClippingBoundary

(

)

const

Returns

The clipping boundary

the Dtk_CompositeEntityPtr which defines the boundary.

GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const

inherited

Get Internal UniqueID.

Returns

InternalID

GetNum2dEntities()

Dtk_Size_t Dtk_View::GetNum2dEntities

(

)

const

Retrieves the 2D entities number - read only -.

Returns

The 2D entities number.

GetNum2dGeometricalEntity()

Dtk_Size_t Dtk_View::GetNum2dGeometricalEntity

(

)

const

Retrieves the number of geometrical entity to the view.

Returns

size of the array

GetNumBodies()

Dtk_Size_t Dtk_View::GetNumBodies

(

)

const

Retrieves the bodies number to be dispalyed- read only -.

Returns

The bodies number.

GetNumOLEObjects()

Dtk_Size_t Dtk_View::GetNumOLEObjects

(

)

const

Retrieves the number of OLE Objects in the Dtk_View.

GetNumPictures()

Dtk_Size_t Dtk_View::GetNumPictures

(

)

const

Retrieves the pictures number - read only -.

Returns

The pictures number.

GetOLEObject()

Dtk_OLEObjectPtr Dtk_View::GetOLEObject

(

const Dtk_Size_t &

inIndex

)

const

Retrieves the OLE Object at index.

GetPicture()

Dtk_picturePtr Dtk_View::GetPicture

(

const Dtk_Size_t &

inPos

)

const

Retrieves the ith Picture.

Parameters

inPos

Picture index.

Returns

the inPos'th Picture.

GetSize()

virtual Dtk_Size_t Dtk_Entity::GetSize ( ) const

virtualinherited

Reimplemented from Dtk_Object.

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_mesh, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, and Dtk_Point.

GetViewDisplay()

Dtk_ViewDisplayPtr Dtk_View::GetViewDisplay

(

)

GetDisplayMode for 3D entity.

Returns

The Display View.

info()

Dtk_InfoPtr& Dtk_Entity::info ( )

inherited

IsView()

bool Dtk_View::IsView

(

ViewType

typeView

)

operator[]()

Dtk_2dEntityPtr Dtk_View::operator[]

(

const Dtk_Size_t &

inPos

)

const

Retrieves the ith 2D entity.

Parameters

inPos

2D entity index.

Returns

the inPos'th 2D entity.

See also

Get2dEntity(const Dtk_Size_t &)

PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )

virtualinherited

Reimplemented in Dtk_OffsetSurface.

Scale() [1/2]

Dtk_Double64& Dtk_View::Scale

(

)

Retrieves the Dtk_View scale - get/set-.

Returns

The Dtk_View scale.

See also

Scale() const

Scale() [2/2]

const Dtk_Double64& Dtk_View::Scale

(

)

const

Retrieves the Dtk_View scale - read only -.

Returns

The Dtk_View scale.

See also

Scale()

SetClippingBoundary()

void Dtk_View::SetClippingBoundary

(

const Dtk_CompositeEntityPtr &

inBoundary

)

const

Sets the clipping boundary informations.

SetClippingPlane()

Dtk_ErrorStatus Dtk_View::SetClippingPlane	(	const Dtk_Size_t &	inPos,
		const Dtk_pnt &	inLocation,
		const Dtk_dir &	inRefAxis,
		const Dtk_dir &	inNormalAxis
	)

Sets the ith clipping plane informations.

Parameters

inPos	The clipping plane index.
inLocation	The clipping plane location.
inRefAxis	The clipping plane reference axis.
inNormalAxis	The clipping plane normal axis.

Returns

DtkNoError if OK.

SetViewDisplay()

void Dtk_View::SetViewDisplay

(

Dtk_ViewDisplayPtr

inDisplay

)

SetDisplayMode for 3D entity to be displayed.

Parameters

inDisplay

Body index.

Transform()

Dtk_ErrorStatus Dtk_View::Transform ( const Dtk_transfo &  inTransfo )

virtual

Applies a transformation matrix to the entity. //!

Parameters

inTransfo

The transformation matrix to apply.

Implements Dtk_Entity.

TransformationMatrix() [1/2]

Dtk_transfo& Dtk_View::TransformationMatrix

(

)

Retrieves the Dtk_View transformation matrix - get/set-.

Returns

The Dtk_View transformation matrix.

See also

TransformationMatrix() const

TransformationMatrix() [2/2]

const Dtk_transfo& Dtk_View::TransformationMatrix

(

)

const

Retrieves the Dtk_View transformation matrix - read only -.

Returns

The Dtk_View transformation matrix.

See also

TransformationMatrix()

Field Documentation

_Private

Dtk_Handle* Dtk_View::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited