LightObjectData Class Reference

#include <c4d_lightobjectdata.h>

Inheritance diagram for LightObjectData:

Public Types
typedef NodeData	SUPER
Public Types inherited from NodeData
typedef PrivateChunk	SUPER

Public Member Functions
virtual Bool	IsInstanceOf (cineware::Int32 id) const
Public Member Functions inherited from NodeData
	NodeData ()
BaseList2D *	GetNode ()
void	SetNode (BaseList2D *ptr)
BaseTag *	GetTag (Int32 id)
BaseTag *	MakeTag (Int32 id)
Public Member Functions inherited from PrivateChunk
	PrivateChunk ()
Bool	ReadChunk (HyperFile *hf, Bool keepin=false, Bool noheader=false)
virtual Bool	IsListHead ()
virtual Int32	GetType () const
virtual Int32	GetInstanceType () const
Bool	ReadObject (HyperFile *hf, Bool readheader)
Bool	WriteObject (HyperFile *hf, Int32 type)
Bool	CopyTo (PrivateChunk *dest, COPYFLAGS flags, AliasTrans *trans)
Bool	GetParameter (Int32 id, GeData &data)
Bool	SetParameter (Int32 id, const GeData &data)
Bool	GetParameter (const DescID &id, GeData &data)
Bool	SetParameter (const DescID &id, const GeData &data)
Public Member Functions inherited from GeTempPublicNode2D< PrivateChunk >
PrivateChunk *	GetNext () const
PrivateChunk *	GetPrev () const
void	InsertBefore (PrivateChunk *n)
void	InsertAfter (PrivateChunk *n)
void	Remove ()

Public Attributes
IESLightData	ieslightdata

Protected Attributes
Float	outerradius
Int32	falloff
Float	outerdist

Private Member Functions
virtual Bool	GetDParameter (const DescID &id, GeData &data)
virtual Bool	SetDParameter (const DescID &id, const GeData &data)
virtual Bool	CopyToX (PrivateChunk *dst, COPYFLAGS flags, AliasTrans *trans)
Int32	GetChunkLevel ()

Private Attributes
Vector	f
Float	bright
Int32	type
Int32	stype
Int32	vtype
Int32	ntype
Bool	showli
Bool	showvl
Bool	showclip
Bool	dark
Float	innerangle
Float	outerangle
Float	innerradius
Bool	ambient
Bool	nodiffuse
Bool	nospecular
Bool	innercone
Bool	innercolor
Bool	colfalloff
Bool	separatepass
Float	contrast
Float	aspectratio
Float	innerdist
Bool	nearclip
Bool	farclip
Float	nearfrom
Float	nearto
Float	farfrom
Float	farto
VNStruct	vn
VLStruct	vl
ShadowStruct	shadow
LFStruct	lf
CausticStruct	caustic

Friends
Bool	SetIESLight (BaseObject *op, IESLight *data, BaseDocument *doc)

Constructor/Destructor
	LightObjectData ()
	~LightObjectData ()

Read/Write
virtual Bool	Read (HyperFile *hf, Int32 id, Int32 level)
virtual Bool	Write (HyperFile *hf)

Additional Inherited Members
Protected Member Functions inherited from NodeData
virtual Bool	Init ()
virtual void	Free ()
virtual Bool	Execute ()
virtual Int32	GetDiskType () const
virtual Bool	TranslateDescID (GeListNode *node, const DescID &id, DescID &res_id, GeListNode *&res_at)
Protected Member Functions inherited from PrivateChunk
virtual Bool	HandleSubChunk (HyperFile *hf, Int32 id, Int32 level)

Detailed Description

Node data class for Cinema 4D's Light object.

Member Typedef Documentation

SUPER

typedef NodeData SUPER

Constructor & Destructor Documentation

LightObjectData()

LightObjectData

(

)

Default constructor.

~LightObjectData()

~LightObjectData

(

)

Destructor.

Member Function Documentation

IsInstanceOf()

virtual Bool IsInstanceOf ( cineware::Int32  id ) const

virtual

Reimplemented from NodeData.

GetDParameter()

virtual Bool GetDParameter ( const DescID &  id, GeData &  data  )

privatevirtual

Reimplemented from PrivateChunk.

SetDParameter()

virtual Bool SetDParameter ( const DescID &  id, const GeData &  data  )

privatevirtual

Reimplemented from PrivateChunk.

CopyToX()

virtual Bool CopyToX ( PrivateChunk *  dst, COPYFLAGS  flags, AliasTrans *  trans  )

privatevirtual

Private.

Reimplemented from NodeData.

GetChunkLevel()

Int32 GetChunkLevel ( )

privatevirtual

Reimplemented from PrivateChunk.

Read()

virtual Bool Read ( HyperFile *  hf, Int32  id, Int32  level  )

virtual

Reads the light object data from a hyper file.

Parameters

[in]	hf	The hyper file to read from. The caller owns the pointed hyper file.
[in]	id	The type ID of the light object to read.
[in]	level	The disklevel of the object to read.

Returns

true if successful, otherwise false.

Reimplemented from NodeData.

Write()

virtual Bool Write ( HyperFile *  hf )

virtual

Writes the light object data to a hyper file.

Parameters

[in]

hf

The hyper file to write to. The caller owns the pointed hyper file.

Returns

true if successful, otherwise false.

Reimplemented from PrivateChunk.

Friends And Related Function Documentation

SetIESLight

Bool SetIESLight ( BaseObject *  op, IESLight *  data, BaseDocument *  doc  )

friend

Sets IES data for a light object.

Parameters

[in]	op	The light object. The caller owns the pointed light object.
[in]	data	The IES data to set. The caller owns the pointed light data.
[in]	doc	The document of the light object. The caller owns the pointed document.

Returns

true if the IES light data was successfully set, otherwise false.

Member Data Documentation

outerradius

Float outerradius

protected

falloff

Int32 falloff

protected

outerdist

Float outerdist

protected

f

Vector f

private

bright

Float bright

private

type

Int32 type

private

stype

Int32 stype

private

vtype

Int32 vtype

private

ntype

Int32 ntype

private

showli

Bool showli

private

showvl

Bool showvl

private

showclip

Bool showclip

private

dark

Bool dark

private

innerangle

Float innerangle

private

outerangle

Float outerangle

private

innerradius

Float innerradius

private

ambient

Bool ambient

private

nodiffuse

Bool nodiffuse

private

nospecular

Bool nospecular

private

innercone

Bool innercone

private

innercolor

Bool innercolor

private

colfalloff

Bool colfalloff

private

separatepass

Bool separatepass

private

contrast

Float contrast

private

aspectratio

Float aspectratio

private

innerdist

Float innerdist

private

nearclip

Bool nearclip

private

farclip

Bool farclip

private

nearfrom

Float nearfrom

private

nearto

Float nearto

private

farfrom

Float farfrom

private

farto

Float farto

private

vn

VNStruct vn

private

vl

VLStruct vl

private

shadow

ShadowStruct shadow

private

lf

LFStruct lf

private

caustic

CausticStruct caustic

private

ieslightdata

IESLightData ieslightdata

Pointer to the IES light data wrapper.