CATFLEditorItf Interface CATIFL2DEntity

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIFL2DEntity

Interface to manage the 2D layout of a logical entity.
Role: This interface is meant to set and retrieve the 2D Layout Position(X,Y) and Size(Width,Height) associated with Logical Reference or Instance.

Note: When the object is a Reference, the 2D Layout information are kept in a logical Representation reference associated with the reference, while when the object is an instance, the same data are kept in the the logical Representation reference associated with its aggregating reference.

So by consequence, when a reference (this or the one aggregating this)is partially loaded (i.e. the reference not opened in Authoring mode), the 2D layout information could be not in session, so all the methods of this interface will fail.

Method Index


o Extract2DGraphRepresentation(CATRep*&)
Extracts the 2D Visualization Representation.
o Get2DPosition(float&,float&)
Retrieves the 2D Position.
o Get2DSize(float&,float&)
Retrieves the 2D dimensions.
o Set2DPosition(float,float)
Sets the 2D Position.
o Set2DSize(float,float)
Sets the 2D Dimensions.

Methods


o Extract2DGraphRepresentation
public virtual HRESULT Extract2DGraphRepresentation(CATRep*& opRep) = 0
Extracts the 2D Visualization Representation.
Role: This method retrieves the 2D visualization representation associated with a Logical Reference/Instance. The method works even if the reference is not edited.
Lifecycle rules deviation: This method doesn't AddRef the returned value
Parameters:
opRep
[out] The 2D visualization representation.
Returns:
An HRESULT.
Legal values:
S_OK
The 2D visualization representation retrieval is successful. opRep is not NULL.
E_FAIL
The 2D visualization representation retrieval has failed
o Get2DPosition
public virtual HRESULT Get2DPosition(float& oX,
float& oY) = 0
Retrieves the 2D Position.
Role: This method retrieves the 2D position(X,Y) of the 2D Layout associated with the Logical Reference/Instance.
Parameters:
oX
[out] The Horizontal Position of the lower left corner of the 2D Layout of the object.
oY
[out] The Vertical Position of the lower left corner of the 2D Layout of the object.
Returns:
An HRESULT.
Legal values:
S_OK
if the current 2D position values of the Logical Reference or Instance are successfully retrieved
E_FAIL
The logical reference is partially loaded, the 2D layout information are not in session, or an internal error
o Get2DSize
public virtual HRESULT Get2DSize(float& oWidth,
float& oHeight) = 0
Retrieves the 2D dimensions.
Role: This method retrieves the 2D Dimensions(Width,Height) of the 2D Layout associated with the Logical Reference/Instance.
Parameters:
oWidth
[out] The Width of the 2D Layout of the object.
oHeight
[out] The Height of the 2D Layout of the object.
Returns:
An HRESULT.
Legal values:
S_OK
if the current 2D size(width,height) values of the Logical Reference or Instance are successfully retrieved
E_FAIL
The logical reference is partially loaded, the 2D layout information are not in session, or an internal error
o Set2DPosition
public virtual HRESULT Set2DPosition(float iX,
float iY) = 0
Sets the 2D Position.
Role: This method sets the 2D position(X,Y) of the 2D Layout associated with the Logical Reference/Instance.
Parameters:
iX
[in] The Horizontal Position of the lower left corner of the 2D Layout of the object.
iY
[in] The Vertical Position of the lower left corner of the 2D Layout of the object.
Returns:
An HRESULT.
Legal values:
S_OK
if the values input are successfully set on the Logical Reference or Instance
E_FAIL
The logical reference is partially loaded, the 2D layout information are not in session, or an internal error
o Set2DSize
public virtual HRESULT Set2DSize(float iWidth,
float iHeight) = 0
Sets the 2D Dimensions.
Role: This method sets the 2D Dimensions(Width,Height) of the 2D Layout associated with the Logical Reference/Instance.
Parameters:
iWidth
[in] The Width of the 2D Layout of the object.
iHeight
[in] The Height of the 2D Layout of the object.
Returns:
An HRESULT.
Legal values:
S_OK
if the values input are successfully set on the Logical Reference or Instance
E_FAIL
The logical reference is partially loaded, the 2D layout information are not in session, or an internal error
This object is included in the file: CATIFL2DEntity.h
If needed, your Imakefile.mk should include the module: CATFLEditorInterfaces

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.