OdCADReference Class

Syntax

C++

class OdCADReference : public OdObject;

Description

This class implements a reference to a CAD object in .pdf documents created with Publish SDK. The interface of this class sets a visual representation of any two-dimensional CAD object by setting its transformation, scale, rotation angle and translation. The target object is defined with the OdCADDefinition class, and the instance of OdCADReference just refers to it. Any modifications are applied to the visual representation, not to the target object. For example, if you have an object with dimension 10x10 units and create a reference to it through the instance of the OdCADReference class, then call the setScale() method with the input parameter value equal to 2.0, the reference object in the document will have a dimension of 20x20 units.

Class Hierarchy

File: PdfPublishCADReference.h

Namespace: OdPdfPublish

Module: API Reference

Methods

Show:Inherited

No members matching the current filter

OdRxObject	Default constructor for this class. (Inherited from OdRxObject)
~OdCADReference	Destroys the CAD reference.
~OdObject	Destroys an instance of a Publish SDK object. (Inherited from OdObject)
~OdRxObject	The virtual destructor for this class. (Inherited from OdRxObject)

Methods

Show:Inherited

No members matching the current filter

addRef	Declares the method incrementing the reference counter in objects derived from this class. (Inherited from OdRxObject)
cast	Casts the specified raw pointer to the smart pointer. (Inherited from OdRxObject)
clear	Clears the Publish SDK object. (Inherited from OdObject)
clone	Creates a clone of this object, and returns a pointer to the clone. (Inherited from OdRxObject)
comparedTo	Compares another object to this one in a some meaning. (Inherited from OdRxObject)
copyFrom	details Copies the contents of the specified object into this object. (Inherited from OdRxObject)
desc	Returns the raw pointer to the class describing instance statically associated with this object as the OdRxClass object. (Inherited from OdRxObject)
getBorder	Returns the current value of the border flag for the CAD reference.
getBorderColor	Returns the current border color for the CAD reference.
getBorderWidth	Returns the current border width for the CAD reference.
getCADDefinition	Returns the current CAD definition object for the CAD reference.
getCADReferenceName	Returns the CAD reference name. The method fills a passed string object with the current name of the CAD reference and returns it to a calling subroutine.
getClipBoundary	Returns the current clipping boundary for the CAD reference.
getClipBoundaryBorder	Returns the current value of the border flag for the CAD reference's clipping boundary. The border flag determines whether the clipping boundary has a border. If the flag value is true, the boundary has a border, otherwise (when flag value is false) it has no border.
getClipBoundaryBorderColor	Returns the current border color for the CAD reference's clipping boundary.
getClipBoundaryBorderWidth	Returns the current border width for the CAD reference's clipping boundary.
getEnableBookmarks	Returns the current value of the bookmarks flag. This flag determines whether bookmarks are supported (equals true) or not (equals false).
getRotation	Returns the current rotation angle for the CAD reference in radians.
getScale	Returns the current scale value for the CAD reference.
getTransform	Returns the current transformation matrix for the CAD reference.
getTranslation	Returns the current translation vector for the CAD reference.
isA	Returns the raw pointer to the class describing instance dynamically associated with this object as the OdRxClass object. (Inherited from OdRxObject)
isEmpty	Determines whether the Publish SDK object is empty. (Inherited from OdObject)
isEqualTo	Returns true if and only if the specified object is equal to this one in a some meaning. (Inherited from OdRxObject)
isKindOf	Checks whether the object belongs to the specified class and returns true if and only if this object is an instance of the specified class or a subclass of the specified class. (Inherited from OdRxObject)
isValid	Determines whether the Publish SDK object is valid. (Inherited from OdObject)
numRefs	Returns the value of the reference counter, that is, the number of references to an instance of this class. (Inherited from OdRxObject)
queryX	Checks whether the object belongs to the specified class and returns a pointer to this object if this object can be converted to the specified class. (Inherited from OdRxObject)
release	Declares the method decrementing the reference counter in objects derived from this class. (Inherited from OdRxObject)
rxInit	for internal use (Inherited from OdRxObject)
rxUninit	(Inherited from OdRxObject)
setBorder	Sets the border flag for the CAD reference.
setBorderColor	Sets the border color for the CAD reference.
setBorderWidth	Sets the border width for the CAD reference.
setCADDefinition	Sets the CADDefinition object for the CAD reference.
setCADReferenceName	Sets the CAD reference name.
setClipBoundary	Sets the clipping boundary for the CAD reference.
setClipBoundaryBorder	Sets the border flag value for the CAD reference's clipping boundary. The border flag determines whether the clipping boundary has a border. If the flag value is true, the boundary has a border, otherwise (when flag value is false) it has no border.
setClipBoundaryBorderColor	Sets the border color for the CAD reference's clipping boundary.
setClipBoundaryBorderWidth	Sets the border width for the CAD reference's clipping boundary.
setEnableBookmarks	Sets the bookmarks support flag. This flag determines whether bookmarks are supported (equals true) or not (equals false).
setRotation	Sets the rotation angle for the CAD reference. The angle is set in radians.
setScale	Sets the the CAD reference scale.
setTransform	Sets the transformation matrix for the CAD reference.
setTranslation	Sets the translation vector for the CAD reference.
x	Checks whether the object belongs to the specified class and returns a pointer to this object if this object can be converted to the specified class, or throws an exception if it cannot. (Inherited from OdRxObject)

Links

OdCADReference Methods

Relief for ODA Team in Ukraine