CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
OdGsUpdateExtents Class Reference

#include <GsDrawableHolder.h>

Public Member Functions

 OdGsUpdateExtents ()
 
 OdGsUpdateExtents (const OdGeExtents3d &extents, OdDb::LineWeight lw=OdDb::kLnWt000)
 
const OdGeExtents3dgetExtents () const
 
OdGeExtents3daccessExtents ()
 
void setExtents (const OdGeExtents3d &extents)
 
void resetExtents ()
 
void addExtents (const OdGeExtents3d &extents)
 
bool hasLineweight () const
 
OdDb::LineWeight getLineweight () const
 
OdDb::LineWeightaccessLineweight ()
 
void setLineweight (OdDb::LineWeight lw)
 
void resetLineweight ()
 
void addLineweight (OdDb::LineWeight lw)
 
void get (OdGeExtents3d &extents, OdDb::LineWeight &lw) const
 
void set (const OdGeExtents3d &extents, OdDb::LineWeight lw)
 
void reset ()
 
void add (const OdGeExtents3d &extents, OdDb::LineWeight lw)
 
void add (const OdGsUpdateExtents &extents)
 
bool isValid () const
 

Static Public Attributes

static GS_STATIC_EXPORT const OdGsUpdateExtents kInvalid
 

Protected Attributes

OdGeExtents3d m_extents
 
OdDb::LineWeight m_lineweight
 

Detailed Description

Corresponding C++ library: TD_Gs

<group OdGs_Classes>

Definition at line 42 of file GsDrawableHolder.h.

Constructor & Destructor Documentation

◆ OdGsUpdateExtents() [1/2]

OdGsUpdateExtents::OdGsUpdateExtents ( )
inline

Default constructor for the OdGsUpdateExtents class. Initializes lineweight to zero lineweight.

Definition at line 54 of file GsDrawableHolder.h.

◆ OdGsUpdateExtents() [2/2]

OdGsUpdateExtents::OdGsUpdateExtents ( const OdGeExtents3d extents,
OdDb::LineWeight  lw = OdDb::kLnWt000 
)
inline

Constructor for the OdGsUpdateExtents class. Creates an instance based on the passed extents and lineweight.

Parameters
extents[in] Extents.
lw[in] Lineweight.

Definition at line 64 of file GsDrawableHolder.h.

Member Function Documentation

◆ accessExtents()

OdGeExtents3d & OdGsUpdateExtents::accessExtents ( )
inline

Returns extents of this object.

Definition at line 81 of file GsDrawableHolder.h.

◆ accessLineweight()

OdDb::LineWeight & OdGsUpdateExtents::accessLineweight ( )
inline

Returns lineweight of this object.

Definition at line 134 of file GsDrawableHolder.h.

◆ add() [1/2]

void OdGsUpdateExtents::add ( const OdGeExtents3d extents,
OdDb::LineWeight  lw 
)
inline

Expands extents of this object and replaces lineweight of this object if the passed lineweight has greater width.

Parameters
extents[in] Extents.
lw[in] Lineweight.

Definition at line 202 of file GsDrawableHolder.h.

◆ add() [2/2]

void OdGsUpdateExtents::add ( const OdGsUpdateExtents extents)
inline

Expands extents of this object and replaces lineweight of this object if the passed object has with greater width.

Parameters
extents[in] Other object to add.

Definition at line 213 of file GsDrawableHolder.h.

◆ addExtents()

void OdGsUpdateExtents::addExtents ( const OdGeExtents3d extents)
inline

Expands the available extents of this object.

Parameters
extents[in] Extents.

Definition at line 107 of file GsDrawableHolder.h.

◆ addLineweight()

void OdGsUpdateExtents::addLineweight ( OdDb::LineWeight  lw)
inline

Replaces lineweight of this object with the passed lineweight if the passed lineweight has greater width.

Parameters
lw[in] Lineweight.

Definition at line 160 of file GsDrawableHolder.h.

◆ get()

void OdGsUpdateExtents::get ( OdGeExtents3d extents,
OdDb::LineWeight lw 
) const
inline

Retrieves parameters of this object.

Parameters
extents[out] Receives extents of this object.
lw[out] Receives lineweight of this object.

Definition at line 171 of file GsDrawableHolder.h.

◆ getExtents()

const OdGeExtents3d & OdGsUpdateExtents::getExtents ( ) const
inline

Returns extents of this object.

Definition at line 73 of file GsDrawableHolder.h.

◆ getLineweight()

OdDb::LineWeight OdGsUpdateExtents::getLineweight ( ) const
inline

Returns lineweight of this object.

Definition at line 126 of file GsDrawableHolder.h.

◆ hasLineweight()

bool OdGsUpdateExtents::hasLineweight ( ) const
inline

Checks whether this object has non-zero lineweight.

Returns
true if this object has non-zero lineweight, false otherwise.

Definition at line 118 of file GsDrawableHolder.h.

◆ isValid()

bool OdGsUpdateExtents::isValid ( ) const
inline

Checks whether extents of this object is valid.

Returns
true if extents of this object is valid, false otherwise.

Definition at line 224 of file GsDrawableHolder.h.

◆ reset()

void OdGsUpdateExtents::reset ( )
inline

Resets extents of this object to invalid extents and lineweight of this object to zero lineweight.

Definition at line 191 of file GsDrawableHolder.h.

◆ resetExtents()

void OdGsUpdateExtents::resetExtents ( )
inline

Resets extents of this object to invalid extents.

Definition at line 98 of file GsDrawableHolder.h.

◆ resetLineweight()

void OdGsUpdateExtents::resetLineweight ( )
inline

Resets lineweight of this object to zero lineweight.

Definition at line 151 of file GsDrawableHolder.h.

◆ set()

void OdGsUpdateExtents::set ( const OdGeExtents3d extents,
OdDb::LineWeight  lw 
)
inline

Sets parameters for this object.

Parameters
extents[in] Extents to set.
lw[in] Lineweight to set.

Definition at line 182 of file GsDrawableHolder.h.

◆ setExtents()

void OdGsUpdateExtents::setExtents ( const OdGeExtents3d extents)
inline

Sets extents of this object.

Parameters
extents[in] Extents.

Definition at line 90 of file GsDrawableHolder.h.

◆ setLineweight()

void OdGsUpdateExtents::setLineweight ( OdDb::LineWeight  lw)
inline

Sets lineweight of this object.

Parameters
lw[in] Lineweight.

Definition at line 143 of file GsDrawableHolder.h.

Member Data Documentation

◆ kInvalid

GS_STATIC_EXPORT const OdGsUpdateExtents OdGsUpdateExtents::kInvalid
static

Invalid extents.

Definition at line 49 of file GsDrawableHolder.h.

◆ m_extents

OdGeExtents3d OdGsUpdateExtents::m_extents
protected

Definition at line 45 of file GsDrawableHolder.h.

◆ m_lineweight

OdDb::LineWeight OdGsUpdateExtents::m_lineweight
protected

Definition at line 46 of file GsDrawableHolder.h.


The documentation for this class was generated from the following file: