CFx SDK Documentation  2020SP3
Public Types | Public Member Functions | List of all members
OdDbRasterImage Class Reference

#include <DbRasterImage.h>

Inheritance diagram for OdDbRasterImage:
OdDbImage OdDbEntity OdDbObject OdGiDrawable OdRxObject OdDbWipeout

Public Types

enum  ClipBoundaryType { kInvalid, kRect, kPoly }
 
enum  ImageDisplayOpt { kShow = 1, kShowUnAligned = 2, kClip = 4, kTransparent = 8 }
 
- Public Types inherited from OdDbEntity
enum  VisualStyleType { kFullVisualStyle, kFaceVisualStyle, kEdgeVisualStyle }
 
- Public Types inherited from OdGiDrawable
enum  SetAttributesFlags {
  kDrawableNone = 0, kDrawableIsAnEntity = 1, kDrawableUsesNesting = 2, kDrawableIsCompoundObject = 4,
  kDrawableViewIndependentViewportDraw = 8, kDrawableIsInvisible = 16, kDrawableHasAttributes = 32, kDrawableRegenTypeDependantGeometry = 64,
  kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128), kDrawableRegenDraw = 256, kDrawableStandardDisplaySingleLOD = 512, kDrawableShadedDisplaySingleLOD = 1024,
  kDrawableViewDependentViewportDraw = 2048, kDrawableBlockDependentViewportDraw = 4096, kDrawableIsExternalReference = 8192, kDrawableNotPlottable = 16384,
  kLastFlag = kDrawableNotPlottable
}
 
enum  DrawableType {
  kGeometry = 0, kDistantLight = 1, kPointLight = 2, kSpotLight = 3,
  kAmbientLight, kSolidBackground, kGradientBackground, kImageBackground,
  kGroundPlaneBackground, kViewport, kWebLight, kSkyBackground,
  kImageBasedLightingBackground
}
 

Public Member Functions

 ODDB_DECLARE_MEMBERS (OdDbRasterImage)
 
 OdDbRasterImage ()
 
virtual void setImageDefId (OdDbObjectId imageDefId)
 
virtual OdDbObjectId imageDefId () const
 
virtual void setReactorId (OdDbObjectId reactorId)
 
virtual OdDbObjectId reactorId () const
 
virtual void setClipBoundary (const OdGePoint2dArray &clipPoints)
 
virtual const OdGePoint2dArray & clipBoundary () const
 
bool isClipped () const
 
virtual OdResult getVertices (OdGePoint3dArray &vertices) const
 
virtual void setClipBoundaryToWholeImage ()
 
ClipBoundaryType clipBoundaryType () const
 
virtual OdGeMatrix3d getPixelToModelTransform () const
 
virtual OdResult setBrightness (OdInt8 brightness)
 
virtual OdInt8 brightness () const
 
virtual OdResult setContrast (OdInt8 contrast)
 
virtual OdInt8 contrast () const
 
virtual OdResult setFade (OdInt8 fade)
 
virtual OdInt8 fade () const
 
virtual void setDisplayOpt (ImageDisplayOpt optionIndex, bool value)
 
virtual bool isSetDisplayOpt (ImageDisplayOpt option) const
 
virtual OdGeVector2d imageSize (bool getCachedValue=false) const
 
virtual OdGeVector2d scale () const
 
virtual bool setOrientation (const OdGePoint3d &origin, const OdGeVector3d &u, const OdGeVector3d &v)
 
virtual void getOrientation (OdGePoint3d &origin, OdGeVector3d &u, OdGeVector3d &v) const
 
virtual void setClipInverted (bool val)
 
virtual bool isClipInverted () const
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler) ODRX_OVERRIDE
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const ODRX_OVERRIDE
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler) ODRX_OVERRIDE
 
virtual void dxfOutFields (OdDbDxfFiler *pFiler) const ODRX_OVERRIDE
 
virtual void subClose () ODRX_OVERRIDE
 
virtual bool subWorldDraw (OdGiWorldDraw *pWd) const ODRX_OVERRIDE
 
virtual void subViewportDraw (OdGiViewportDraw *pVd) const ODRX_OVERRIDE
 
virtual OdResult subGetGeomExtents (OdGeExtents3d &extents) const ODRX_OVERRIDE
 
virtual OdResult subGetClassID (void *pClsid) const ODRX_OVERRIDE
 
virtual OdResult subTransformBy (const OdGeMatrix3d &xfm) ODRX_OVERRIDE
 
virtual OdResult subExplode (OdRxObjectPtrArray &entitySet) const ODRX_OVERRIDE
 
virtual OdDbObjectPtr subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *, bool bPrimary) const ODRX_OVERRIDE
 
- Public Member Functions inherited from OdDbImage
 ODDB_DECLARE_MEMBERS (OdDbImage)
 
 OdDbImage ()
 
- Public Member Functions inherited from OdDbEntity
 ODDB_DECLARE_MEMBERS (OdDbEntity)
 
 OdDbEntity ()
 
OdDbObjectId blockId () const
 
OdCmColor color () const
 
virtual OdResult setColor (const OdCmColor &color, bool doSubents=true)
 
OdUInt16 colorIndex () const
 
virtual OdCmEntityColor entityColor () const
 
virtual OdResult setColorIndex (OdUInt16 colorIndex, bool doSubents=true)
 
OdDbObjectId colorId () const
 
virtual OdResult setColorId (OdDbObjectId colorId, bool doSubents=true)
 
OdCmTransparency transparency () const
 
virtual OdResult setTransparency (const OdCmTransparency &transparency, bool doSubents=true)
 
OdString plotStyleName () const
 
OdDb::PlotStyleNameType getPlotStyleNameId (OdDbObjectId &plotStyleNameId) const
 
virtual OdResult setPlotStyleName (const OdString &plotStyleName, bool doSubents=true)
 
virtual OdResult setPlotStyleName (OdDb::PlotStyleNameType plotStyleNameType, OdDbObjectId plotStyleNameId=OdDbObjectId::kNull, bool doSubents=true)
 
OdString layer () const
 
OdDbObjectId layerId () const
 
virtual OdResult setLayer (const OdString &layerName, bool doSubents=true, bool allowHiddenLayer=false)
 
virtual OdResult setLayer (OdDbObjectId layerId, bool doSubents=true, bool allowHiddenLayer=false)
 
OdString linetype () const
 
OdDbObjectId linetypeId () const
 
virtual OdResult setLinetype (const OdString &linetypeName, bool doSubents=true)
 
virtual OdResult setLinetype (OdDbObjectId linetypeID, bool doSubents=true)
 
OdString material () const
 
OdDbObjectId materialId () const
 
virtual OdResult setMaterial (const OdString &materialName, bool doSubents=true)
 
virtual OdResult setMaterial (OdDbObjectId materialID, bool doSubents=true)
 
OdDbObjectId visualStyleId (VisualStyleType vstype=kFullVisualStyle) const
 
virtual OdResult setVisualStyle (OdDbObjectId visualStyleId, VisualStyleType vstype=kFullVisualStyle, bool doSubents=true)
 
virtual const OdGiMapper * materialMapper () const
 
virtual void setMaterialMapper (const OdGiMapper *mapper, bool doSubents=true)
 
double linetypeScale () const
 
virtual OdResult setLinetypeScale (double linetypeScale, bool doSubents=true)
 
OdDb::Visibility visibility () const
 
ODRX_SEALED_VIRTUAL OdResult setVisibility (OdDb::Visibility visibility, bool doSubents=true) ODRX_SEALED
 
OdDb::Visibility tempVisibility () const
 
void setTempVisibility (OdDb::Visibility visibility)
 
OdDb::LineWeight lineWeight () const
 
virtual OdResult setLineWeight (OdDb::LineWeight lineWeight, bool doSubents=true)
 
virtual bool castShadows () const
 
virtual void setCastShadows (bool castShadows)
 
virtual bool receiveShadows () const
 
virtual void setReceiveShadows (bool receiveShadows)
 
virtual OdDb::CollisionType collisionType () const
 
void setPropertiesFrom (const OdDbEntity *pSource, bool doSubents=true)
 
virtual bool isPlanar () const
 
virtual OdResult getPlane (OdGePlane &plane, OdDb::Planarity &planarity) const
 
void subHandOverTo (OdDbObject *pNewObject)
 
ODRX_SEALED_VIRTUAL OdResult transformBy (const OdGeMatrix3d &xfm) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getTransformedCopy (const OdGeMatrix3d &xfm, OdDbEntityPtr &pCopy) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult explode (OdRxObjectPtrArray &entitySet) const ODRX_SEALED
 
virtual OdResult explodeToBlock (OdDbBlockTableRecord *pBlockRecord, OdDbObjectIdArray *ids=0)
 
virtual OdResult explodeGeometry (OdRxObjectPtrArray &entitySet) const
 
virtual OdResult explodeGeometryToBlock (OdDbBlockTableRecord *pBlockRecord, OdDbObjectIdArray *ids=0)
 
void setDatabaseDefaults (OdDbDatabase *pDb=0, bool doSubents=false)
 
virtual void subSetDatabaseDefaults (OdDbDatabase *pDb, bool doSubents)
 
virtual void applyPartialUndo (OdDbDwgFiler *pUndoFiler, OdRxClass *pClassObj)
 
void appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap)
 
virtual OdResult dxfIn (OdDbDxfFiler *pFiler)
 
virtual void dxfOut (OdDbDxfFiler *pFiler) const
 
virtual OdResult dxfInFields_R12 (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields_R12 (OdDbDxfFiler *pFiler) const
 
virtual OdGiDrawable * drawable ()
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *pTraits) const
 
virtual void subList () const
 
void subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual OdResult subErase (bool erasing) ODRX_OVERRIDE
 
void recordGraphicsModified (bool graphicsModified=true)
 
virtual void copyFrom (const OdRxObject *pSource)
 
ODRX_SEALED_VIRTUAL void list () const ODRX_SEALED
 
virtual OdResult getGeomExtents (OdGeExtents3d &extents) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void highlight (bool bDoIt=true, const OdDbFullSubentPath *pSubId=0, bool highlightAll=false) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints, const OdGeMatrix3d &insertionMat) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool isContentSnappable () const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getGripPoints (OdGePoint3dArray &gripPoints) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult moveGripPointsAt (const OdIntArray &indices, const OdGeVector3d &offset) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getGripPoints (OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const int bitFlags) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult moveGripPointsAt (const OdDbVoidPtrArray &grips, const OdGeVector3d &offset, int bitFlags) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getStretchPoints (OdGePoint3dArray &stretchPoints) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult moveStretchPointsAt (const OdIntArray &indices, const OdGeVector3d &offset) ODRX_SEALED
 
virtual void dragStatus (const OdDb::DragStat status)
 
ODRX_SEALED_VIRTUAL void gripStatus (const OdDb::GripStat status) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool cloneMeForDragging () ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool hideMeForDragging () const ODRX_SEALED
 
virtual void saveAs (OdGiWorldDraw *pWd, OdDb::DwgVersion ver) const
 
ODRX_SEALED_VIRTUAL OdResult getCompoundObjectTransform (OdGeMatrix3d &xM) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult intersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult intersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, const OdGePlane &projPlane, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const ODRX_SEALED
 
OdResult boundingBoxIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, OdGePoint3dArray &points, OdGsMarker thisGsMarker, OdGsMarker otherGsMarker) const
 
OdResult boundingBoxIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, const OdGePlane &projPlane, OdGePoint3dArray &points, OdGsMarker thisGsMarker, OdGsMarker otherGsMarker) const
 
ODRX_SEALED_VIRTUAL OdResult getSubentPathsAtGsMarker (OdDb::SubentType type, OdGsMarker gsMark, const OdGePoint3d &pickPoint, const OdGeMatrix3d &xfm, OdDbFullSubentPathArray &subentPaths, const OdDbObjectIdArray *pEntAndInsertStack=0) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getGsMarkersAtSubentPath (const OdDbFullSubentPath &subPath, OdGsMarkerArray &gsMarkers) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getGripPointsAtSubentPath (const OdDbFullSubentPath &path, OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const OdUInt32 bitflags) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult moveGripPointsAtSubentPaths (const OdDbFullSubentPathArray &paths, const OdDbVoidPtrArray &gripAppData, const OdGeVector3d &offset, const OdUInt32 bitflags) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult deleteSubentPaths (const OdDbFullSubentPathArray &paths) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult addSubentPaths (const OdDbFullSubentPathArray &paths) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbEntityPtr subentPtr (const OdDbFullSubentPath &path) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult transformSubentPathsBy (const OdDbFullSubentPathArray &paths, const OdGeMatrix3d &xform) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getSubentClassId (const OdDbFullSubentPath &path, void *clsId) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getSubentPathGeomExtents (const OdDbFullSubentPath &path, OdGeExtents3d &extents) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void subentGripStatus (OdDb::GripStat status, const OdDbFullSubentPath &subentity) ODRX_SEALED
 
virtual OdGeMatrix3d getEcs () const
 
- Public Member Functions inherited from OdDbObject
 ODDB_DECLARE_MEMBERS (OdDbObject)
 
 ~OdDbObject ()
 
void addRef ()
 
void release ()
 
long numRefs () const
 
OdDbObjectId objectId () const
 
OdDbHandle getDbHandle () const
 
OdDbHandle handle () const
 
OdDbObjectId ownerId () const
 
virtual void setOwnerId (OdDbObjectId ownerId)
 
OdDbDatabase * database () const
 
void createExtensionDictionary ()
 
OdDbObjectId extensionDictionary () const
 
bool releaseExtensionDictionary ()
 
OdDbXrecordPtr createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)
 
void upgradeOpen ()
 
void downgradeOpen ()
 
void cancel ()
 
virtual OdResult subOpen (OdDb::OpenMode mode)
 
OdResult erase (bool eraseIt=true)
 
void handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)
 
void swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual void audit (OdDbAuditInfo *pAuditInfo)
 
void dwgIn (OdDbDwgFiler *pFiler)
 
void dwgOut (OdDbDwgFiler *pFiler) const
 
virtual OdDb::DuplicateRecordCloning mergeStyle () const
 
virtual OdResBufPtr xData (const OdString &regappName=OdString::kEmpty) const
 
virtual void setXData (const OdResBuf *pRb)
 
bool isEraseStatusToggled () const
 
bool isErased () const
 
bool isReadEnabled () const
 
bool isWriteEnabled () const
 
bool isNotifyEnabled () const
 
bool isModified () const
 
bool isModifiedXData () const
 
bool isModifiedGraphics () const
 
bool isNewObject () const
 
bool isNotifying () const
 
bool isUndoing () const
 
bool isReallyClosing () const
 
bool isDBRO () const
 
void assertReadEnabled () const
 
void assertWriteEnabled (bool autoUndo=true, bool recordModified=true)
 
void assertNotifyEnabled () const
 
void disableUndoRecording (bool disable)
 
bool isUndoRecordingDisabled () const
 
OdDbDwgFiler * undoFiler ()
 
void addReactor (OdDbObjectReactor *pReactor) const
 
void removeReactor (OdDbObjectReactor *pReactor) const
 
virtual void addPersistentReactor (const OdDbObjectId &objId)
 
virtual void removePersistentReactor (const OdDbObjectId &objId)
 
bool hasPersistentReactor (const OdDbObjectId &objId) const
 
OdDbObjectIdArray getPersistentReactors () const
 
OdDbObjectReactorArray getTransientReactors () const
 
virtual void recvPropagateModify (const OdDbObject *pSubObj)
 
virtual void xmitPropagateModify () const
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr deepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr wblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
void setOdDbObjectIdsInFlux ()
 
bool isOdDbObjectIdsInFlux () const
 
virtual void copied (const OdDbObject *pObject, const OdDbObject *pNewObject)
 
virtual void erased (const OdDbObject *pObject, bool erasing=true)
 
virtual void goodbye (const OdDbObject *pObject)
 
virtual void openedForModify (const OdDbObject *pObject)
 
virtual void modified (const OdDbObject *pObject)
 
virtual void subObjModified (const OdDbObject *pObject, const OdDbObject *pSubObj)
 
virtual void modifyUndone (const OdDbObject *pObject)
 
virtual void modifiedXData (const OdDbObject *pObject)
 
virtual void unappended (const OdDbObject *pObject)
 
virtual void reappended (const OdDbObject *pObject)
 
bool isAProxy () const
 
virtual void objectClosed (const OdDbObjectId &objectId)
 
virtual void modifiedGraphics (const OdDbObject *pObject)
 
bool hasSaveVersionOverride () const
 
void setHasSaveVersionOverride (bool hasSaveVersionOverride)
 
virtual OdDb::DwgVersion getObjectSaveVersion (const OdDbFiler *pFiler, OdDb::MaintReleaseVer *pMaintVer=0) const
 
virtual OdDbObjectPtr decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
 
virtual OdDbObjectPtr decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
 
void convertForSave (OdDb::DwgVersion ver)
 
virtual void composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)
 
virtual bool isPersistent () const
 
virtual OdDbStub * id () const
 
ODRX_SEALED_VIRTUAL OdResult getClassID (void *pClsid) const ODRX_SEALED
 
void setGsNode (OdGsCache *pNode)
 
OdGsCache * gsNode () const
 
void xDataTransformBy (const OdGeMatrix3d &xfm)
 
bool hasFields () const
 
OdDbObjectId getField (const OdString &fieldName) const
 
OdDbObjectPtr getField (const OdString &fieldName, OdDb::OpenMode mode) const
 
virtual OdDbObjectId setField (const OdString &fieldName, OdDbField *pField)
 
virtual OdResult removeField (OdDbObjectId fieldId)
 
virtual OdDbObjectId removeField (const OdString &fieldName)
 
OdDbObjectId getFieldDictionary () const
 
OdDbObjectPtr getFieldDictionary (OdDb::OpenMode mode) const
 
virtual OdRxClass * saveAsClass (OdRxClass *pClass) const
 
- Public Member Functions inherited from OdGiDrawable
 ODRX_DECLARE_MEMBERS (OdGiDrawable)
 
virtual DrawableType drawableType () const
 
ODRX_SEALED_VIRTUAL OdUInt32 setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdUInt32 viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdUInt32 regenSupportFlags () const ODRX_SEALED
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObject * queryX (const OdRxClass *pClass) const
 
virtual OdRxObject * x (const OdRxClass *pClass) const
 
virtual OdRxClass * isA () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClass * desc ()
 
- Protected Member Functions inherited from OdDbEntity
virtual OdDbObjectPtr subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *, bool bPrimary) const ODRX_OVERRIDE
 
virtual OdResult subGetTransformedCopy (const OdGeMatrix3d &xfm, OdDbEntityPtr &pCopy) const
 
virtual OdResult subGetCompoundObjectTransform (OdGeMatrix3d &xM) const
 
virtual bool subCloneMeForDragging ()
 
virtual bool subHideMeForDragging () const
 
virtual void subGripStatus (const OdDb::GripStat status)
 
virtual OdResult subGetOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints) const
 
virtual OdResult subGetOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints, const OdGeMatrix3d &insertionMat) const
 
virtual bool subIsContentSnappable () const
 
virtual OdResult subGetGripPoints (OdGePoint3dArray &gripPoints) const
 
virtual OdResult subMoveGripPointsAt (const OdIntArray &indices, const OdGeVector3d &offset)
 
virtual OdResult subGetGripPoints (OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const int bitFlags) const
 
virtual OdResult subMoveGripPointsAt (const OdDbVoidPtrArray &grips, const OdGeVector3d &offset, int bitFlags)
 
virtual OdResult subGetStretchPoints (OdGePoint3dArray &stretchPoints) const
 
virtual OdResult subMoveStretchPointsAt (const OdIntArray &indices, const OdGeVector3d &offset)
 
virtual OdResult subIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const
 
virtual OdResult subIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, const OdGePlane &projPlane, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const
 
virtual void subHighlight (bool bDoIt=true, const OdDbFullSubentPath *pSubId=0, bool highlightAll=false) const
 
virtual OdDb::Visibility subVisibility () const
 
virtual OdResult subSetVisibility (OdDb::Visibility visibility, bool doSubents=true)
 
virtual OdResult subDeleteSubentPaths (const OdDbFullSubentPathArray &paths)
 
virtual OdResult subAddSubentPaths (const OdDbFullSubentPathArray &paths)
 
virtual OdResult subMoveGripPointsAtSubentPaths (const OdDbFullSubentPathArray &paths, const OdDbVoidPtrArray &gripAppData, const OdGeVector3d &offset, const OdUInt32 bitflags)
 
virtual OdResult subGetGripPointsAtSubentPath (const OdDbFullSubentPath &path, OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const OdUInt32 bitflags) const
 
virtual OdResult subGetSubentPathsAtGsMarker (OdDb::SubentType type, OdGsMarker gsMark, const OdGePoint3d &pickPoint, const OdGeMatrix3d &xfm, OdDbFullSubentPathArray &subentPaths, const OdDbObjectIdArray *pEntAndInsertStack=0) const
 
virtual OdResult subGetGsMarkersAtSubentPath (const OdDbFullSubentPath &subPath, OdGsMarkerArray &gsMarkers) const
 
virtual OdDbEntityPtr subSubentPtr (const OdDbFullSubentPath &path) const
 
virtual OdResult subTransformSubentPathsBy (const OdDbFullSubentPathArray &paths, const OdGeMatrix3d &xform)
 
virtual OdResult subGetSubentClassId (const OdDbFullSubentPath &path, void *clsId) const
 
virtual OdResult subGetSubentPathGeomExtents (const OdDbFullSubentPath &path, OdGeExtents3d &extents) const
 
virtual void subSubentGripStatus (OdDb::GripStat status, const OdDbFullSubentPath &subentity)
 
- Protected Member Functions inherited from OdDbObject
 OdDbObject ()
 
- Protected Member Functions inherited from OdGiDrawable
 OdGiDrawable ()
 
virtual OdUInt32 subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const
 
virtual OdUInt32 subRegenSupportFlags () const
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImpl * m_pImpl
 

Detailed Description

This class represents RasterImage entities in an OdDbDatabase instance.

See also
TD_Db

<group OdDb_Classes>

Definition at line 47 of file DbRasterImage.h.

Member Enumeration Documentation

◆ ClipBoundaryType

enum OdDbRasterImage::ClipBoundaryType
Enumerator
kInvalid 
kRect 
kPoly 

Definition at line 54 of file DbRasterImage.h.

◆ ImageDisplayOpt

enum OdDbRasterImage::ImageDisplayOpt
Enumerator
kShow 
kShowUnAligned 
kClip 
kTransparent 

Definition at line 61 of file DbRasterImage.h.

Constructor & Destructor Documentation

◆ OdDbRasterImage()

OdDbRasterImage::OdDbRasterImage ( )

Member Function Documentation

◆ brightness()

virtual OdInt8 OdDbRasterImage::brightness ( ) const
virtual

Returns the brightness value for this raster image entity (DXF 281).

Returns
Returns a value in the range [0.0 .. 100.0].

◆ clipBoundary()

virtual const OdGePoint2dArray& OdDbRasterImage::clipBoundary ( ) const
virtual

Returns the clip boundary for this raster image entity (DXF 14, 24).

Remarks
The clip boundary is specified in pixel coordinates.

◆ clipBoundaryType()

ClipBoundaryType OdDbRasterImage::clipBoundaryType ( ) const

Returns the clip boundary type of this this raster image entity (DXF 71).

◆ contrast()

virtual OdInt8 OdDbRasterImage::contrast ( ) const
virtual

Returns the contrast value for this raster image entity (DXF 282).

Returns
Returns a value in the range [0.0 .. 100.0].

◆ dwgInFields()

virtual OdResult OdDbRasterImage::dwgInFields ( OdDbDwgFiler *  pFiler)
virtual

TBC. OdGiSentScanLines* getScanLines(const OdGiRequestScanLines& req) const; bool freeScanLines(OdGiSentScanLines* pSSL) const;

coment it for a while, because we do not know what it do static Oda::ClassVersion classVersion();

Reimplemented from OdDbEntity.

Reimplemented in OdDbWipeout.

◆ dwgOutFields()

virtual void OdDbRasterImage::dwgOutFields ( OdDbDwgFiler *  pFiler) const
virtual

Writes the .dwg file data of this object.

Parameters
pFiler[in] Pointer to the filer to which data are written.
Remarks

This function is called by dwgIn() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbEntity.

Reimplemented in OdDbWipeout.

◆ dxfInFields()

virtual OdResult OdDbRasterImage::dxfInFields ( OdDbDxfFiler *  pFiler)
virtual

Reads the DXF data of this object.

Parameters
pFiler[in] Pointer to the filer from which data are read.
Returns
Returns the filer status.

This function is called by dxfIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbEntity.

Reimplemented in OdDbWipeout.

◆ dxfOutFields()

virtual void OdDbRasterImage::dxfOutFields ( OdDbDxfFiler *  pFiler) const
virtual

Writes the DXF data of this object.

Parameters
pFiler[in] Pointer to the filer to which data are to be written.
Remarks

This function is called by dxfOut() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbEntity.

Reimplemented in OdDbWipeout.

◆ fade()

virtual OdInt8 OdDbRasterImage::fade ( ) const
virtual

Returns the fade value for this raster image entity (DXF 283).

Returns
Returns a value in the range [0.0 .. 100.0].

◆ getOrientation()

virtual void OdDbRasterImage::getOrientation ( OdGePoint3d &  origin,
OdGeVector3d &  u,
OdGeVector3d &  v 
) const
virtual

Returns the orientation and origin of this raster image entity.

Parameters
origin[out] Receives the lower-left corner.
u[out] Receives the vector defining the image direction and width.
v[out] Receives the vector defining the direction of the height of the image.
Remarks
These vectors define the outer edges of the raster image entity.

◆ getPixelToModelTransform()

virtual OdGeMatrix3d OdDbRasterImage::getPixelToModelTransform ( ) const
virtual

Returns the pixel-to-model coordinate transformation matrix for this raster image entity.

◆ getVertices()

virtual OdResult OdDbRasterImage::getVertices ( OdGePoint3dArray &  vertices) const
virtual

Adds the frame vertices of this raster image entity to the specified array.

Parameters
vertices[in/out] Receives the vertices of the image frame.
Remarks
If isClipped(), these are the vertices of the clip boundary.

If !isClipped(), these are the corners of the image.

◆ imageDefId()

virtual OdDbObjectId OdDbRasterImage::imageDefId ( ) const
virtual

Returns the Object ID of the OdDbRasterImageDef object associated with this raster image entity (DXF 340).

◆ imageSize()

virtual OdGeVector2d OdDbRasterImage::imageSize ( bool  getCachedValue = false) const
virtual

Returns the size in pixels of this raster image entity (DXF 13, 23).

Parameters
getCachedValue[in] True to always return cached value. False to return the value from the OdDbRasterImageDef object of available.

◆ isClipInverted()

virtual bool OdDbRasterImage::isClipInverted ( ) const
virtual

Returns the ClipInverted flag value for this raster image entity.

◆ isClipped()

bool OdDbRasterImage::isClipped ( ) const

Returns the clipping state for this raster image entity (DXF 280).

◆ isSetDisplayOpt()

virtual bool OdDbRasterImage::isSetDisplayOpt ( ImageDisplayOpt  option) const
virtual

Returns the specified image display option for this raster image entity (DXF 70).

Parameters
optionIndex[in] Option to return.

◆ ODDB_DECLARE_MEMBERS()

OdDbRasterImage::ODDB_DECLARE_MEMBERS ( OdDbRasterImage  )

◆ reactorId()

virtual OdDbObjectId OdDbRasterImage::reactorId ( ) const
virtual

Returns the Object ID of the OdDbRasterImageDefReactor object associated with this raster image entity (DXF 360).

Remarks
Each OdDbRasterImage object must have an OdDbRasterImageDefReactor associated with the OdDbRasterImageDef object it is using.

◆ scale()

virtual OdGeVector2d OdDbRasterImage::scale ( ) const
virtual

Returns the effective scale factor of this raster image entity.

Remarks
The effective scale factor is the image size in drawing units divided by the original image size.

If the original image size is unavalable, or the user has not defined a drawing unit, the image width is assumed to be one drawing unit.

◆ setBrightness()

virtual OdResult OdDbRasterImage::setBrightness ( OdInt8  brightness)
virtual

Sets the brightness value for this raster image entity (DXF 281).

Parameters
brightness[in] Image brightness [0.0 .. 100.0].

◆ setClipBoundary()

virtual void OdDbRasterImage::setClipBoundary ( const OdGePoint2dArray &  clipPoints)
virtual

Sets the clip boundary for this raster image entity (DXF 71, 14, 24).

Parameters
clipPoints[in] Array of 2D points in pixel coordinates.

◆ setClipBoundaryToWholeImage()

virtual void OdDbRasterImage::setClipBoundaryToWholeImage ( )
virtual

Sets the clip boundary to coincide with the image corners of this raster image entity.

Remarks
Any existing boundary is deleted.

◆ setClipInverted()

virtual void OdDbRasterImage::setClipInverted ( bool  val)
virtual

Sets the ClipInverted flag value for this raster image entity.

Parameters
val[in] The ClipInverted flag value.

◆ setContrast()

virtual OdResult OdDbRasterImage::setContrast ( OdInt8  contrast)
virtual

Sets the contrast value for this raster image entity (DXF 282).

Parameters
contrast[in] Image contrast. [0.0 .. 100.0]

◆ setDisplayOpt()

virtual void OdDbRasterImage::setDisplayOpt ( ImageDisplayOpt  optionIndex,
bool  value 
)
virtual

Sets the specified image display option for this raster image entity (DXF 70).

Parameters
optionIndex[in] Option index.
value[in] Value for option.
Remarks
option is one of the following:

Value Description kShow 1 Show kShowUnAligned 2 Show unaligned kClip 4 Clip kTransparent 8 Transparent

◆ setFade()

virtual OdResult OdDbRasterImage::setFade ( OdInt8  fade)
virtual

Sets the fade value for this raster image entity (DXF 283).

Parameters
fade[in] Image fade. [0.0 .. 100.0].

◆ setImageDefId()

virtual void OdDbRasterImage::setImageDefId ( OdDbObjectId  imageDefId)
virtual

Sets the Object ID of the OdDbRasterImageDef object associated with this raster image entity (DXF 340).

Parameters
imageDefId[in] Object ID of image to be displayed.

◆ setOrientation()

virtual bool OdDbRasterImage::setOrientation ( const OdGePoint3d &  origin,
const OdGeVector3d &  u,
const OdGeVector3d &  v 
)
virtual

Sets the orientation and origin of this raster image entity.

Parameters
origin[in] Lower-left corner.
u[in] Image width vector.
v[in] Image height vector.
Returns
Returns true if and only if successful.
Remarks
The actual height of the image is determined by the width and aspect ratio fo the original image.

These vectors define the outer edges of the raster image entity.

◆ setReactorId()

virtual void OdDbRasterImage::setReactorId ( OdDbObjectId  reactorId)
virtual

Sets the OdDbRasterImageDefReactor object associated with this raster image entity (DXF 360).

Parameters
reactorId[in] Object ID of reactor for this image.
Remarks
Each OdDbRasterImage object must have an OdDbRasterImageDefReactor associated with the OdDbRasterImageDef object it is using. This call makes this OdDbRasterImage object the owner of the reactor object.

◆ subClose()

virtual void OdDbRasterImage::subClose ( )
virtual

Called as the first operation as this object is being closed, for database -resident objects only.

Remarks
This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operatons.

When overriding this function:

1) If the OdDbObject's state is incorrect, throw exception.

2) Call parent class's subClose().

3) If other actions are required before close, do them.

The default implementation of this function does nothing. This function can be overridden in custom classes.

Reimplemented from OdDbObject.

◆ subDeepClone()

virtual OdDbObjectPtr OdDbRasterImage::subDeepClone ( OdDbIdMapping &  ownerIdMap,
OdDbObject *  ,
bool  bPrimary 
) const
virtual

Reimplemented from OdDbEntity.

◆ subExplode()

virtual OdResult OdDbRasterImage::subExplode ( OdRxObjectPtrArray &  entitySet) const
virtual

Reimplemented from OdDbEntity.

◆ subGetClassID()

virtual OdResult OdDbRasterImage::subGetClassID ( void *  pClsid) const
virtual

Reimplemented from OdDbEntity.

Reimplemented in OdDbWipeout.

◆ subGetGeomExtents()

virtual OdResult OdDbRasterImage::subGetGeomExtents ( OdGeExtents3d &  extents) const
virtual

Reimplemented from OdDbEntity.

◆ subTransformBy()

virtual OdResult OdDbRasterImage::subTransformBy ( const OdGeMatrix3d &  xfm)
virtual

Reimplemented from OdDbEntity.

◆ subViewportDraw()

virtual void OdDbRasterImage::subViewportDraw ( OdGiViewportDraw *  pVd) const
virtual

Reimplemented from OdDbEntity.

◆ subWorldDraw()

virtual bool OdDbRasterImage::subWorldDraw ( OdGiWorldDraw *  pWd) const
virtual

Reimplemented from OdDbEntity.

Reimplemented in OdDbWipeout.

The documentation for this class was generated from the following file:
Generated on Mon Oct 12 2020 11:49:59