Dtk_ModelDisplay Class Reference

This is the Dtk_ModelDisplay class. Please use the Dtk_ModelDisplayPtr class to handle it... More...

Inheritance diagram for Dtk_ModelDisplay:

Public Types
enum	RenderingModeEnum {   rendering_mode_shaded_only =0, rendering_mode_shaded_with_visible_edges, rendering_mode_wireframe_with_all_edges, rendering_mode_wireframe_with_only_visible_edges,   rendering_mode_static_wireframe, rendering_mode_wireframe_face_analysis, rendering_mode_wireframe_partially_shade, rendering_mode_studio,   rendering_mode_unknown }
enum	SectionTypeEnum {   SectionPlane = 0, SectionPlaneList, SectionParallelePlane, SectionBox,   SectionBody, SectionUndefined }

Public Member Functions
virtual Dtk_ErrorStatus	_Store (void *)
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_InfoPtr	get_info () const
type_detk	get_type_detk () const
const Dtk_CameraPtr &	GetCamera () const
	Retrieves the Dtk_ModelDisplay camera - read only -. More...
Dtk_EntityPtr	GetClippingEntity () const
	Retrieves the Dtk_ModelDisplay clipping entity - read only -. More...
const Dtk_ID &	GetID () const
	Get Internal UniqueID. More...
Dtk_bool	GetIsStandardView () const
	Get DTK_TRUE if this Dtk_ModelDisplay is a Standard View , DTK_FALSE if it is a user defined view . More...
RenderingModeEnum	GetRenderingMode () const
	Get the rendering mode shaded , shaded with edge , ... More...
void	GetSectionInformation (SectionTypeEnum &outSectionType, Dtk_Int32 &outIsLocked, Dtk_Double64 &outThickness) const
	Get the type of the Section on the Dtk_Capture. More...
virtual Dtk_Size_t	GetSize () const
void	GetVisibleLayers (Dtk_tab< Dtk_Int32 > &outVisibleLayers) const
	Visible layer for Dtk_ModelDisplay. More...
Dtk_InfoPtr &	info ()
Dtk_bool	IsActivated () const
	Tells if the Dtk_ModelDisplay is activated or not - read only -. More...
virtual void	PrepareTransfo ()
void	SetIsStandardView () const
	Set if this Dtk_ModelDisplay is a Standard View other case it is a user defined view. More...
void	SetRenderingMode (RenderingModeEnum inMode) const
	Set the rendering mode shaded , shaded with edge , ... More...
void	SetSectionInformation (const SectionTypeEnum &inSectionType, const Dtk_Int32 &inIsLocked=DTK_FALSE, const Dtk_Double64 &inThickness=0.0) const
	Set the type of the Section on the Dtk_Capture. More...
void	SetVisibleLayers (const Dtk_tab< Dtk_Int32 > &inVisibleLayers)
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the entity. //! More...

Static Public Member Functions
static Dtk_ModelDisplayPtr	Create (const Dtk_CameraPtr &inCamera, const Dtk_EntityPtr &inClippingEntity, const Dtk_bool inIsActivated)
	Full featured constructor. More...
static Dtk_ModelDisplay *	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_MODEL_DISPLAY }

Protected Member Functions
void	_copy (const Dtk_Entity &s)
void	_copy (const Dtk_Object &s)
void	_init ()
void	_reset ()
virtual Dtk_Object *	Clone ()
	Dtk_ModelDisplay ()
	Dtk_ModelDisplay (const Dtk_CameraPtr &inCamera, const Dtk_EntityPtr &inClippingEntity, const Dtk_bool inIsActivated)
	Dtk_ModelDisplay (const Dtk_ModelDisplay &s)
	~Dtk_ModelDisplay ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Friends
class	Dtk_SmartPtr< Dtk_ModelDisplay >

Detailed Description

This is the Dtk_ModelDisplay class. Please use the Dtk_ModelDisplayPtr 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_MODEL_DISPLAY };

RenderingModeEnum

enum Dtk_ModelDisplay::RenderingModeEnum

Enumerator
rendering_mode_shaded_only
rendering_mode_shaded_with_visible_edges
rendering_mode_wireframe_with_all_edges
rendering_mode_wireframe_with_only_visible_edges
rendering_mode_static_wireframe
rendering_mode_wireframe_face_analysis
rendering_mode_wireframe_partially_shade
rendering_mode_studio
rendering_mode_unknown

     {
          rendering_mode_shaded_only=0,
          rendering_mode_shaded_with_visible_edges,
          rendering_mode_wireframe_with_all_edges,
          rendering_mode_wireframe_with_only_visible_edges,
          rendering_mode_static_wireframe,
          rendering_mode_wireframe_face_analysis,
          rendering_mode_wireframe_partially_shade,
          rendering_mode_studio,
          rendering_mode_unknown
     };

SectionTypeEnum

enum Dtk_ModelDisplay::SectionTypeEnum

Enumerator
SectionPlane
SectionPlaneList
SectionParallelePlane
SectionBox
SectionBody
SectionUndefined

                          {
          SectionPlane = 0,
          SectionPlaneList,
          SectionParallelePlane,
          SectionBox,
          SectionBody,
          SectionUndefined
     };

Constructor & Destructor Documentation

Dtk_ModelDisplay() [1/3]

Dtk_ModelDisplay::Dtk_ModelDisplay ( )

protected

See also

Create()

Dtk_ModelDisplay() [2/3]

Dtk_ModelDisplay::Dtk_ModelDisplay ( const Dtk_ModelDisplay &  s )

protected

See also

Create(const Dtk_ModelDisplay&)

Dtk_ModelDisplay() [3/3]

Dtk_ModelDisplay::Dtk_ModelDisplay ( const Dtk_CameraPtr &  inCamera, const Dtk_EntityPtr &  inClippingEntity, const Dtk_bool  inIsActivated  )

protected

See also

Create(const Dtk_CameraPtr& , const Dtk_EntityPtr&, const Dtk_bool)

~Dtk_ModelDisplay()

Dtk_ModelDisplay::~Dtk_ModelDisplay ( )

protected

Destructor.

Member Function Documentation

_copy() [1/2]

void Dtk_Entity::_copy ( const Dtk_Entity &  s )

protectedinherited

_copy() [2/2]

void Dtk_Object::_copy ( const Dtk_Object &  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.

Clone()

virtual Dtk_Object* Dtk_ModelDisplay::Clone ( )

protectedvirtual

Implements Dtk_Entity.

{ return new Dtk_ModelDisplay(*this); }

Create()

static Dtk_ModelDisplayPtr Dtk_ModelDisplay::Create ( const Dtk_CameraPtr &  inCamera, const Dtk_EntityPtr &  inClippingEntity, const Dtk_bool  inIsActivated  )

static

Full featured constructor.

Parameters

inCamera	The included Dtk_Camera.
inClipping	The included clipping entity.
inIsActivated	Tells if the Capture is activated or not.

Returns

The created Dtk_ModelDisplayPtr

DtkDynamicCast()

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

static

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_ModelDisplay::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

get_info()

Dtk_InfoPtr Dtk_Entity::get_info ( ) const

inherited

get_type_detk()

type_detk Dtk_ModelDisplay::get_type_detk ( ) const

virtual

Returns

The type of the entity type - DTK_TYPE_MODEL_DISPLAY -

Implements Dtk_Entity.

{ return DTK_TYPE_MODEL_DISPLAY; }

GetCamera()

const Dtk_CameraPtr& Dtk_ModelDisplay::GetCamera

(

)

const

Retrieves the Dtk_ModelDisplay camera - read only -.

Returns

The camera.

GetClippingEntity()

Dtk_EntityPtr Dtk_ModelDisplay::GetClippingEntity

(

)

const

Retrieves the Dtk_ModelDisplay clipping entity - read only -.

Returns

The clipping entity.

GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const

inherited

Get Internal UniqueID.

Returns

InternalID

GetIsStandardView()

Dtk_bool Dtk_ModelDisplay::GetIsStandardView

(

)

const

Get DTK_TRUE if this Dtk_ModelDisplay is a Standard View , DTK_FALSE if it is a user defined view .

GetRenderingMode()

RenderingModeEnum Dtk_ModelDisplay::GetRenderingMode

(

)

const

Get the rendering mode shaded , shaded with edge , ...

GetSectionInformation()

void Dtk_ModelDisplay::GetSectionInformation	(	SectionTypeEnum &	outSectionType,
		Dtk_Int32 &	outIsLocked,
		Dtk_Double64 &	outThickness
	)		const

Get the type of the Section on the Dtk_Capture.

SectionPlane : clipping by one plane , GetClippingEntity() return a Dtk_PlaneSurfacePtr .

SectionParallelePlane : clipping by two plane ,first one , GetClippingEntity() return a Dtk_PlaneSurfacePtr ,and the second is defined by a thickness from this plane.

SectionBox : clipping by a box defined by six planes , GetClippingEntity() return a Dtk_BodyPtr with six plane surface.

SectionBox : clipping by a Dtk_BodyPtr , GetClippingEntity() return a Dtk_BodyPtr .

Parameters

outSectionType

the section type , outIsLocked if Section distance is locked and outThickness for SectionParallelePlane.

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.

GetVisibleLayers()

void Dtk_ModelDisplay::GetVisibleLayers

(

Dtk_tab< Dtk_Int32 > &

outVisibleLayers

)

const

Visible layer for Dtk_ModelDisplay.

info()

Dtk_InfoPtr& Dtk_Entity::info ( )

inherited

IsActivated()

Dtk_bool Dtk_ModelDisplay::IsActivated

(

)

const

Tells if the Dtk_ModelDisplay is activated or not - read only -.

Returns

DTK_TRUE if capture is visible when opening the document (several can be activated ) DTK_FALSE else.

PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )

virtualinherited

Reimplemented in Dtk_OffsetSurface.

SetIsStandardView()

void Dtk_ModelDisplay::SetIsStandardView

(

)

const

Set if this Dtk_ModelDisplay is a Standard View other case it is a user defined view.

SetRenderingMode()

void Dtk_ModelDisplay::SetRenderingMode

(

RenderingModeEnum

inMode

)

const

Set the rendering mode shaded , shaded with edge , ...

SetSectionInformation()

void Dtk_ModelDisplay::SetSectionInformation	(	const SectionTypeEnum &	inSectionType,
		const Dtk_Int32 &	inIsLocked = DTK_FALSE,
		const Dtk_Double64 &	inThickness = 0.0
	)		const

Set the type of the Section on the Dtk_Capture.

Parameters

inSectionType

the section type , inIsLocked if Section distance is locked and inThickness for SectionParallelePlane .

SetVisibleLayers()

void Dtk_ModelDisplay::SetVisibleLayers

(

const Dtk_tab< Dtk_Int32 > &

inVisibleLayers

)

Transform()

Dtk_ErrorStatus Dtk_ModelDisplay::Transform ( const Dtk_transfo &  inTransfo )

virtual

Applies a transformation matrix to the entity. //!

Parameters

inTransfo

The transformation matrix to apply.

Implements Dtk_Entity.

Friends And Related Function Documentation

Dtk_SmartPtr< Dtk_ModelDisplay >

friend class Dtk_SmartPtr< Dtk_ModelDisplay >

friend

Field Documentation

_Private

Dtk_Handle* Dtk_ModelDisplay::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited