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

#include <IfcLightSourceAutoImpl.h>

Inheritance diagram for OdIfc2x2_final::IfcLightSource:
OdIfc2x2_final::IfcGeometricRepresentationItem OdIfc2x2_final::IfcRepresentationItem OdIfc::OdIfcEntity OdIfc2x2_final::IfcLightSourceAmbient OdIfc2x2_final::IfcLightSourceDirectional OdIfc2x2_final::IfcLightSourceGoniometric OdIfc2x2_final::IfcLightSourcePositional OdIfc2x2_final::IfcLightSourceSpot

Public Member Functions

const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdDAIObjectId & getLightColour () const
 
void setLightColour (const OdDAIObjectId &LightColour)
 
double getAmbientIntensity () const
 
void setAmbientIntensity (double AmbientIntensity)
 
double getIntensity () const
 
void setIntensity (double Intensity)
 
 IfcLightSource ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
- Public Member Functions inherited from OdIfc::OdIfcEntity
 ODRX_DECLARE_MEMBERS (OdIfcEntity)
 
 OdIfcEntity ()
 
 ~OdIfcEntity ()
 
virtual bool isKindOf (OdIfcEntityType entityType) const
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
virtual OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfcAttribute attrDef) const
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool testAttr (const OdIfcAttribute explicitAttrDef) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual void unsetAttr (const OdIfcAttribute explicitAttrDef)
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool putAttr (const OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
IfcOpResult resolved ()
 
void resolve (IfcOpResult resolved, void *resPtr)
 
void unresolve ()
 
virtual void setGsNode (OdGsCache *pGsNode)
 
virtual OdGsCache * gsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 

Protected Attributes

OdAnsiString m_Name
 
OdDAIObjectId m_LightColour
 
IfcNormalisedRatioMeasure m_AmbientIntensity
 
IfcNormalisedRatioMeasure m_Intensity
 
- Protected Attributes inherited from OdIfc::OdIfcEntity
void * m_resPtr
 
IfcOpResult m_resolved
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcEntity
static const OdGePoint3d * asPoint3d (const OdIfcEntity *pEnt)
 
static const OdGePoint2d * asPoint2d (const OdIfcEntity *pEnt)
 
static const OdGeVector3d * asVector3d (const OdIfcEntity *pEnt)
 
static const OdGeVector2d * asVector2d (const OdIfcEntity *pEnt)
 
static const OdGeMatrix2d * asMatrix2d (const OdIfcEntity *pEnt)
 
static const OdGeMatrix3d * asMatrix3d (const OdIfcEntity *pEnt)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcEntity > pEnt)
 
static const OdCmEntityColor * asRgbColor (const OdIfcEntity *pEnt)
 

Detailed Description

Definition at line 38 of file Ifc2x2_Final/IfcLightSourceAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcLightSource()

OdIfc2x2_final::IfcLightSource::IfcLightSource ( )

Member Function Documentation

◆ getAmbientIntensity()

double OdIfc2x2_final::IfcLightSource::getAmbientIntensity ( ) const

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x2_final::IfcLightSource::getAttr ( const char *  attrName) const
virtual

Returns an attribute value for the specified attribute name.

Parameters
attrName[in] Name of an attribute to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented in OdIfc2x2_final::IfcLightSourceDirectional, OdIfc2x2_final::IfcLightSourceGoniometric, OdIfc2x2_final::IfcLightSourcePositional, and OdIfc2x2_final::IfcLightSourceSpot.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x2_final::IfcLightSource::getAttr ( const OdIfc::OdIfcAttribute  attrDef) const
virtual

Returns an attribute value for the specified attribute definition.

Parameters
attrDef[in] Attribute definition to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc::OdIfcEntity.

Reimplemented in OdIfc2x2_final::IfcLightSourceDirectional, OdIfc2x2_final::IfcLightSourceGoniometric, OdIfc2x2_final::IfcLightSourcePositional, and OdIfc2x2_final::IfcLightSourceSpot.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x2_final::IfcLightSource::getInstanceType ( ) const
virtual

Returns a type of a class instance.

Returns
Pointer to the <link OdDAI__Entity, OdDAI::Entity> type that determines an entity definition within a schema.

Reimplemented from OdIfc2x2_final::IfcGeometricRepresentationItem.

Reimplemented in OdIfc2x2_final::IfcLightSourceAmbient, OdIfc2x2_final::IfcLightSourceDirectional, OdIfc2x2_final::IfcLightSourceGoniometric, OdIfc2x2_final::IfcLightSourcePositional, and OdIfc2x2_final::IfcLightSourceSpot.

◆ getIntensity()

double OdIfc2x2_final::IfcLightSource::getIntensity ( ) const

◆ getLightColour()

const OdDAIObjectId & OdIfc2x2_final::IfcLightSource::getLightColour ( ) const

◆ getName()

const OdAnsiString & OdIfc2x2_final::IfcLightSource::getName ( ) const

◆ inFields()

virtual OdResult OdIfc2x2_final::IfcLightSource::inFields ( OdDAI::OdSpfFilerBase *  rdFiler)
virtual

Reads object's data from the specified filer.

Parameters
rdFiler[in] Pointer to a filer from which to read the data.
Returns
A value of OdResult type that contains the result of the method execution.

Reimplemented in OdIfc2x2_final::IfcLightSourceDirectional, OdIfc2x2_final::IfcLightSourceGoniometric, OdIfc2x2_final::IfcLightSourcePositional, and OdIfc2x2_final::IfcLightSourceSpot.

◆ isKindOf()

virtual bool OdIfc2x2_final::IfcLightSource::isKindOf ( OdIfc::OdIfcEntityType  entityType) const
virtual

Checks whether the specified instance is the object derived from or belongs to this class.

Parameters
entityType[in] Entity to check.
Returns
true if the specified instance is the object derived from or belongs to this class, false otherwise.

Reimplemented from OdIfc2x2_final::IfcGeometricRepresentationItem.

Reimplemented in OdIfc2x2_final::IfcLightSourceAmbient, OdIfc2x2_final::IfcLightSourceDirectional, OdIfc2x2_final::IfcLightSourceGoniometric, OdIfc2x2_final::IfcLightSourcePositional, and OdIfc2x2_final::IfcLightSourceSpot.

◆ outFields()

virtual OdResult OdIfc2x2_final::IfcLightSource::outFields ( OdDAI::OdSpfFilerBase *  wrFiler)
virtual

Writes object's data the the specified filer.

Parameters
wrFiler[in] Pointer to a filer to which to write the data.
Returns
A value of OdResult type that contains the result of the method execution.

Reimplemented in OdIfc2x2_final::IfcLightSourceDirectional, OdIfc2x2_final::IfcLightSourceGoniometric, OdIfc2x2_final::IfcLightSourcePositional, and OdIfc2x2_final::IfcLightSourceSpot.

◆ putAttr() [1/2]

virtual bool OdIfc2x2_final::IfcLightSource::putAttr ( const char *  explicitAttrName,
const OdRxValue &  val 
)
virtual

Sets the specified attribute with a given value.

Parameters
explicitAttrName[in] Explicit name of the attribute to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc::OdIfcEntity.

Reimplemented in OdIfc2x2_final::IfcLightSourceDirectional, OdIfc2x2_final::IfcLightSourceGoniometric, OdIfc2x2_final::IfcLightSourcePositional, and OdIfc2x2_final::IfcLightSourceSpot.

◆ putAttr() [2/2]

virtual bool OdIfc2x2_final::IfcLightSource::putAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef,
const OdRxValue &  val 
)
virtual

Sets the specified attribute with a given value.

Parameters
explicitAttrDef[in] Explicit attribute definition to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc::OdIfcEntity.

Reimplemented in OdIfc2x2_final::IfcLightSourceDirectional, OdIfc2x2_final::IfcLightSourceGoniometric, OdIfc2x2_final::IfcLightSourcePositional, and OdIfc2x2_final::IfcLightSourceSpot.

◆ setAmbientIntensity()

void OdIfc2x2_final::IfcLightSource::setAmbientIntensity ( double  AmbientIntensity)

◆ setIntensity()

void OdIfc2x2_final::IfcLightSource::setIntensity ( double  Intensity)

◆ setLightColour()

void OdIfc2x2_final::IfcLightSource::setLightColour ( const OdDAIObjectId &  LightColour)

◆ setName()

void OdIfc2x2_final::IfcLightSource::setName ( const OdAnsiString &  Name)

◆ testAttr() [1/2]

virtual bool OdIfc2x2_final::IfcLightSource::testAttr ( const char *  explicitAttrName) const
virtual

Checks whether the specified attribute is set.

Parameters
explicitAttrName[in] Explicit name of the attribute to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc::OdIfcEntity.

Reimplemented in OdIfc2x2_final::IfcLightSourceDirectional, OdIfc2x2_final::IfcLightSourceGoniometric, OdIfc2x2_final::IfcLightSourcePositional, and OdIfc2x2_final::IfcLightSourceSpot.

◆ testAttr() [2/2]

virtual bool OdIfc2x2_final::IfcLightSource::testAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef) const
virtual

Checks whether the specified attribute is set.

Parameters
explicitAttrDef[in] Attribute definition to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc::OdIfcEntity.

Reimplemented in OdIfc2x2_final::IfcLightSourceDirectional, OdIfc2x2_final::IfcLightSourceGoniometric, OdIfc2x2_final::IfcLightSourcePositional, and OdIfc2x2_final::IfcLightSourceSpot.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x2_final::IfcLightSource::type ( ) const
virtual

Returns the type of this entity.

Returns
A value of the <link OdIfc__OdIfcEntityType, OdIfc::OdIfcEntityType> type that represents type of this entity.

Reimplemented from OdIfc2x2_final::IfcGeometricRepresentationItem.

Reimplemented in OdIfc2x2_final::IfcLightSourceAmbient, OdIfc2x2_final::IfcLightSourceDirectional, OdIfc2x2_final::IfcLightSourceGoniometric, OdIfc2x2_final::IfcLightSourcePositional, and OdIfc2x2_final::IfcLightSourceSpot.

◆ unsetAttr() [1/2]

virtual void OdIfc2x2_final::IfcLightSource::unsetAttr ( const char *  explicitAttrName)
virtual

Resets a value for the specified attribute.

Parameters
explicitAttrName[in] Explicit name of the attribute to reset.

Reimplemented from OdIfc::OdIfcEntity.

Reimplemented in OdIfc2x2_final::IfcLightSourceDirectional, OdIfc2x2_final::IfcLightSourceGoniometric, OdIfc2x2_final::IfcLightSourcePositional, and OdIfc2x2_final::IfcLightSourceSpot.

◆ unsetAttr() [2/2]

virtual void OdIfc2x2_final::IfcLightSource::unsetAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef)
virtual

Resets a value for the specified attribute.

Parameters
explicitAttrDef[in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc::OdIfcEntity.

Reimplemented in OdIfc2x2_final::IfcLightSourceDirectional, OdIfc2x2_final::IfcLightSourceGoniometric, OdIfc2x2_final::IfcLightSourcePositional, and OdIfc2x2_final::IfcLightSourceSpot.

Member Data Documentation

◆ m_AmbientIntensity

IfcNormalisedRatioMeasure OdIfc2x2_final::IfcLightSource::m_AmbientIntensity
protected

Definition at line 168 of file Ifc2x2_Final/IfcLightSourceAutoImpl.h.

◆ m_Intensity

IfcNormalisedRatioMeasure OdIfc2x2_final::IfcLightSource::m_Intensity
protected

Definition at line 169 of file Ifc2x2_Final/IfcLightSourceAutoImpl.h.

◆ m_LightColour

OdDAIObjectId OdIfc2x2_final::IfcLightSource::m_LightColour
protected

Definition at line 167 of file Ifc2x2_Final/IfcLightSourceAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc2x2_final::IfcLightSource::m_Name
protected

Definition at line 166 of file Ifc2x2_Final/IfcLightSourceAutoImpl.h.

The documentation for this class was generated from the following file:
Generated on Wed Apr 5 2023 17:33:43