CMacro3D Class Reference
[Calques 3D - Geometrical Objects]

Inheritance diagram for CMacro3D:

Collaboration diagram for CMacro3D:

Detailed Description


Public Member Functions
virtual DWORD	isA () const
	Get the identifier representing the type of the object.
virtual void	Serialize (CArchive &ar)
	Store and load the object into and from an archive.
int	SetProperties (CxObject3DSet *pSet=NULL)
	Call the property dialog box and modify the object's attributes.
virtual int	SetDepth ()
	Update the depth of this object in the dependence graph.
virtual CxObject3DSet *	GetParents ()
	Get all the parents of this object from the dependence graph.
virtual BOOL	ChangeParent (CObject3D pOld, CObject3D pNew, BOOL bUpGraph=FALSE)
	Change one of the parents of the object.
virtual CString	GetObjectDef ()
	Get the definition of the object.
virtual CString	GetObjectHelp ()
	Get the designation of the object.
virtual CString	GetObjectName ()
	Get the name of the object.
virtual void	Draw (CDC , CVisualParam vp, BOOL bSM=FALSE)
	Method CObject3D::Draw.
virtual CString	ExportSymbolic (int nFormat)
	Method CObject3D::ExportSymbolic.
Public Attributes
CxObject3DSet	cParentList
	List of the free-points of the macro (ie graft targets).

Member Function Documentation

virtual DWORD isA ( ) const [inline, virtual]

Get the identifier representing the type of the object.

See TObject3DClass and others identifiers

Reimplemented from CCompositeObj3D.

void Serialize ( CArchive & ar ) [virtual]

Store and load the object into and from an archive.

Parameters:

A CArchive object to serialize to or from.

Reimplemented from CCompositeObj3D.

int SetProperties ( CxObject3DSet * pSet = NULL ) [virtual]

Call the property dialog box and modify the object's attributes.

Parameters:

pSet

A pointer to the list of all objects in the construction.

Returns:: TRUE if attributes have been modified, FALSE otherwise

Reimplemented from CCompositeObj3D.

int SetDepth ( ) [virtual]

Update the depth of this object in the dependence graph.

Basically, the depth of an object is either 0 if it has no parents or the maximum of its parents' depth +1.

Returns:: The current depth of this object

Reimplemented from CObject3D.

CxObject3DSet * GetParents ( ) [virtual]

Get all the parents of this object from the dependence graph.

Returns:: A pointer to a list containing the parents, NULL if no parents.

Reimplemented from CObject3D.

BOOL ChangeParent	(	CObject3D *	pOld,
		CObject3D *	pNew,
		BOOL	bUpGraph = `FALSE`
	)			`[virtual]`

Change one of the parents of the object.

Parameters:

	pOld	A pointer to the parent object to change.
	pNew	A pointer to the object to replace the current parent with.
	bUpGraph	TRUE if the dependence graph needs to be updated, FALSE otherwise

Returns:: TRUE is the parent has been properly changed, FALSE otherwise

Reimplemented from CObject3D.

CString GetObjectDef ( ) [virtual]

Get the definition of the object.

The definition of an object is a string containing a complete description of the object, including references to the objects to which it depends for its construction. Names of the objects and its parents are automatically updated. For example, a segment will be defined by "S is a segment line going through A and B". This definition is mainly used to populate the History view (see CViewHisto) and the status bar when an object is designated (see CViewUniv::OnUpdateObjTooltip).

Reimplemented from CObject3D.

CString GetObjectHelp ( ) [virtual]

Get the designation of the object.

The designation of an object is a short string containing its name and its type. For example, a segment will be designated by "The segment S". The designation is mainly used in the tooltips appearing in the views when the user designates the object (see CViewUniv::OnUpdateObjTooltip).

Reimplemented from CObject3D.

CString GetObjectName ( ) [virtual]

Get the name of the object.

The method returns a string containing either the name as edited by the user (and stored in strObjectName) or, if empty, the default name as retrieved by GetNameID,

Reimplemented from CObject3D.

void Draw	(	CDC *	pDC,
		CVisualParam *	vp,
		BOOL	bSm = `FALSE`
	)			`[virtual]`

Method CObject3D::Draw.

Parameters:

	pDC	A pointer to the device-context associated with the drawing view
	vp	A pointer to the visual parameters of the view
	bSm	TRUE if the object is displayed in a reduced form, FALSE otherwise

Reimplemented from CCompositeObj3D.

CString ExportSymbolic ( int nFormat ) [virtual]

Method CObject3D::ExportSymbolic.

Parameters:

nFormat

The format to use for exporting the object (see CObject3D::TGraphType)