Dtk_ViewDisplay Class Reference

This is the Dtk_ViewDisplay class to set the Display mode for the bodies stored in a view. More...

Inheritance diagram for Dtk_ViewDisplay:

Public Types
enum	DisplayMode3DEnum {   DefaultDisplay = 0, WireframeDisplay = 1, WithHiddenDisplay = 2, NoHiddenDisplay = 3,   ShadingDisplay = 4, ShadingWithEdgeDisplay = 5 }

Public Member Functions
Dtk_Int32	DtkDynamicType (const Dtk_Int32 &inId)
	Retrieves the dynamic entity type. More...
virtual int	DtkDynamicType (const int &inId)=0
virtual void	dump (FILE *file=stdout)
type_detk	get_type_detk () const
DisplayMode3DEnum	GetDisplayMode ()
	Return the Display Mode. More...
Dtk_ErrorStatus	GetHiddenEdgesLineStyle (Dtk_FontLineType &outLineFont, Dtk_Double64 &outLineWidth, Dtk_RGB &outLineColor) const
	Retrieves Line style for Hidden Edges. More...
virtual Dtk_Size_t	GetSize () const
Dtk_ErrorStatus	GetTangentEdgesLineStyle (Dtk_FontLineType &outLineFont, Dtk_Double64 &outLineWidth, Dtk_RGB &outLineColor) const
	Retrieves Line style for Tangent Edges. More...
Dtk_ErrorStatus	GetVisibleEdgesLineStyle (Dtk_FontLineType &outLineFont, Dtk_Double64 &outLineWidth, Dtk_RGB &outLineColor) const
	Retrieves Line style for Visible Edges. More...
void	SetHiddenEdgesLineStyle (Dtk_FontLineType inLineFont, Dtk_Double64 inLineWidth, Dtk_RGB inLineColor)
	Set Line style for Hidden Edges. More...
void	SetTangentEdgesLineStyle (Dtk_FontLineType inLineFont, Dtk_Double64 inLineWidth, Dtk_RGB inLineColor)
	Set Line style for Tangent Edges. More...
void	SetVisibleEdgesLineStyle (Dtk_FontLineType inLineFont, Dtk_Double64 inLineWidth, Dtk_RGB inLineColor)
	Set Line style for Visible Edges. More...

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

Protected Types
enum	{ _typeID = DTK_TYPE_OBJECT }
enum	{ _typeID = DTK_TYPE_VIEW_DISPLAY }

Protected Member Functions
virtual Dtk_Object *	Clone ()
	Dtk_ViewDisplay ()
	Dtk_ViewDisplay (const Dtk_ViewDisplay &s)
	Dtk_ViewDisplay (DisplayMode3DEnum inDisplayMode)
	Dtk_ViewDisplay (Dtk_ViewDisplay &&s) DTK_NOEXCEPT
	~Dtk_ViewDisplay ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is the Dtk_ViewDisplay class to set the Display mode for the bodies stored in a view.

See also

Use Dtk_ViewDisplayPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_OBJECT }; 

anonymous enum

anonymous enum

protected

Enumerator
_typeID

     {
          _typeID = DTK_TYPE_VIEW_DISPLAY
     };

DisplayMode3DEnum

enum Dtk_ViewDisplay::DisplayMode3DEnum

Enumerator
DefaultDisplay
WireframeDisplay
WithHiddenDisplay
NoHiddenDisplay
ShadingDisplay
ShadingWithEdgeDisplay

     {
          DefaultDisplay = 0,
          WireframeDisplay = 1, 
          WithHiddenDisplay = 2,  
          NoHiddenDisplay = 3,  
          ShadingDisplay = 4,
          ShadingWithEdgeDisplay = 5
     };

Constructor & Destructor Documentation

Dtk_ViewDisplay() [1/4]

Dtk_ViewDisplay::Dtk_ViewDisplay ( )

protected

See also

Create()

Dtk_ViewDisplay() [2/4]

Dtk_ViewDisplay::Dtk_ViewDisplay ( const Dtk_ViewDisplay &  s )

protected

See also

Create( const Dtk_View& )

Dtk_ViewDisplay() [3/4]

Dtk_ViewDisplay::Dtk_ViewDisplay ( Dtk_ViewDisplay &&  s )

protected

See also

Create( Dtk_View&& )

Dtk_ViewDisplay() [4/4]

Dtk_ViewDisplay::Dtk_ViewDisplay ( DisplayMode3DEnum  inDisplayMode )

protected

See also

Create( DisplayMode3DEnum )

~Dtk_ViewDisplay()

Dtk_ViewDisplay::~Dtk_ViewDisplay ( )

protected

Destructor.

Member Function Documentation

Clone()

virtual Dtk_Object* Dtk_ViewDisplay::Clone ( )

protectedvirtual

     {
          return new Dtk_ViewDisplay( *this );
     }

Create() [1/3]

static Dtk_ViewDisplayPtr Dtk_ViewDisplay::Create ( const Dtk_ViewDisplay &  in )

static

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

Create() [2/3]

static Dtk_ViewDisplayPtr Dtk_ViewDisplay::Create ( DisplayMode3DEnum  inDisplayMode )

static

Calls default constructor to allocate a new object.

Create() [3/3]

static Dtk_ViewDisplayPtr Dtk_ViewDisplay::Create ( Dtk_ViewDisplay &&  in )

static

Calls move constructor to allocate a new object.

Parameters

in	Object to move from.

DtkDynamicCast()

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

static

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_ViewDisplay::DtkDynamicType

(

const Dtk_Int32 &

inId

)

Retrieves the dynamic entity type.

DtkDynamicType() [2/2]

virtual int Dtk_Object::DtkDynamicType ( const int &  inId )

pure virtualinherited

Implemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, Dtk_MeshPolyline, 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, Dtk_AxisSystem, Dtk_Preview, Dtk_Entity, Dtk_picture, Dtk_OverrideSet, Dtk_OverrideInfo, Dtk_MainDoc, Dtk_Component, Dtk_Node, Dtk_DocElement, Dtk_Log, and Dtk_Properties.

dump()

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

virtualinherited

get_type_detk()

type_detk Dtk_ViewDisplay::get_type_detk

(

)

const

Returns

The type of the entity type - DTK_TYPE_VIEW_DISPLAY -

     {
          return DTK_TYPE_VIEW_DISPLAY;
     }

GetDisplayMode()

DisplayMode3DEnum Dtk_ViewDisplay::GetDisplayMode

(

)

Return the Display Mode.

GetHiddenEdgesLineStyle()

Dtk_ErrorStatus Dtk_ViewDisplay::GetHiddenEdgesLineStyle	(	Dtk_FontLineType &	outLineFont,
		Dtk_Double64 &	outLineWidth,
		Dtk_RGB &	outLineColor
	)		const

Retrieves Line style for Hidden Edges.

Parameters

outLineFont	Line Font - Solid, Dimmed, ...-
outLineWidth	Line Width in MM
outLineColor	Line Color

Returns

dtkNoError if Success.

GetSize()

virtual Dtk_Size_t Dtk_Object::GetSize ( ) const

virtualinherited

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_mesh_face, 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, Dtk_Point, Dtk_Entity, and Dtk_Info.

GetTangentEdgesLineStyle()

Dtk_ErrorStatus Dtk_ViewDisplay::GetTangentEdgesLineStyle	(	Dtk_FontLineType &	outLineFont,
		Dtk_Double64 &	outLineWidth,
		Dtk_RGB &	outLineColor
	)		const

Retrieves Line style for Tangent Edges.

Parameters

outLineFont	Line Font - Solid, Dimmed, ...-
outLineWidth	Line Width in MM
outLineColor	Line Color

Returns

dtkNoError if Success.

GetVisibleEdgesLineStyle()

Dtk_ErrorStatus Dtk_ViewDisplay::GetVisibleEdgesLineStyle	(	Dtk_FontLineType &	outLineFont,
		Dtk_Double64 &	outLineWidth,
		Dtk_RGB &	outLineColor
	)		const

Retrieves Line style for Visible Edges.

Parameters

outLineFont	Line Font - Solid, Dimmed, ...-
outLineWidth	Line Width in MM
outLineColor	Line Color

Returns

dtkNoError if Success.

SetHiddenEdgesLineStyle()

void Dtk_ViewDisplay::SetHiddenEdgesLineStyle	(	Dtk_FontLineType	inLineFont,
		Dtk_Double64	inLineWidth,
		Dtk_RGB	inLineColor
	)

Set Line style for Hidden Edges.

Parameters

inLineFont	Line Font - Solid, Dimmed, ...-
inLineWidth	Line Width in MM
inLineColor	Line Color

SetTangentEdgesLineStyle()

void Dtk_ViewDisplay::SetTangentEdgesLineStyle	(	Dtk_FontLineType	inLineFont,
		Dtk_Double64	inLineWidth,
		Dtk_RGB	inLineColor
	)

Set Line style for Tangent Edges.

Parameters

inLineFont	Line Font - Solid, Dimmed, ...-
inLineWidth	Line Width in MM
inLineColor	Line Color

SetVisibleEdgesLineStyle()

void Dtk_ViewDisplay::SetVisibleEdgesLineStyle	(	Dtk_FontLineType	inLineFont,
		Dtk_Double64	inLineWidth,
		Dtk_RGB	inLineColor
	)

Set Line style for Visible Edges.

Parameters

inLineFont	Line Font - Solid, Dimmed, ...-
inLineWidth	Line Width in MM
inLineColor	Line Color

Field Documentation

_Private

Dtk_Handle* Dtk_ViewDisplay::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited