UVWTag Class Reference

#include <c4d_uvwtag.h>

Inheritance diagram for UVWTag:

Public Types

typedef BaseTag SUPER
 
- Public Types inherited from BaseTag
typedef BaseList2D SUPER
 
- Public Types inherited from BaseList2D
typedef GeListNode SUPER
 
- Public Types inherited from GeListNode
typedef PrivateChunk SUPER
 

Public Member Functions

virtual Bool IsInstanceOf (cineware::Int32 id) const
 
- Public Member Functions inherited from BaseTag
 BaseTag (Int32 id=NOTOK, Int32 pD=NOTOK)
 
virtual ~BaseTag ()
 
BaseTagGetNext ()
 
BaseTagGetPred ()
 
virtual Int32 GetType () const
 
virtual Int32 GetDiskType () const
 
virtual BaseList2DGetClone (COPYFLAGS flags, AliasTrans *trans)
 
virtual Bool CopyDataV (BaseTag *dest, COPYFLAGS flags, AliasTrans *trans)
 
BaseObjectGetObject ()
 
- Public Member Functions inherited from BaseList2D
 BaseList2D ()
 
virtual ~BaseList2D ()
 
BaseList2DGetNext ()
 
BaseList2DGetPred ()
 
NodeDataGetNodeData ()
 
void SetNodeData (NodeData *data)
 
void SetBit (Int32 mask)
 
Bool GetBit (Int32 mask)
 
void DelBit (Int32 mask)
 
void ToggleBit (Int32 mask)
 
Int32 GetAllBits ()
 
void SetAllBits (Int32 bits)
 
BaseContainer GetData ()
 
BaseContainerGetDataInstance ()
 
BaseContainerGetDataInstanceRef ()
 
const StringGetName ()
 
void SetName (const String &new_name)
 
const GeMarkerGetMarker () const
 
void SetMarker (const GeMarker &m)
 
Bool AddUniqueID (Int32 appid, const Char *const mem, Int bytes)
 
Bool FindUniqueID (Int32 appid, const Char *&mem, Int &bytes) const
 
Int32 GetUniqueIDCount () const
 
Bool GetUniqueIDIndex (Int32 idx, Int32 &id, const Char *&mem, Int &bytes) const
 
BaseShaderGetFirstShader ()
 
Bool InsertShader (BaseShader *shader, BaseShader *pred=nullptr)
 
Bool InsertShaderLast (BaseShader *shader)
 
RootCTrackGetCTrackRoot ()
 
CTrackGetFirstCTrack ()
 
CTrackFindCTrack (const DescID &id)
 
Bool AppendCTrack (CTrack *t)
 
void InsertTrackSorted (CTrack *track)
 
LayerObjectGetLayerObject ()
 
void SetLayerObject (LayerObject *layer)
 
const LayerDataGetLayerData (BaseDocument *doc, Bool rawdata=false)
 
Bool SetLayerData (BaseDocument *doc, const LayerData &data)
 
DynamicDescriptionGetDynamicDescription ()
 
virtual Bool IsBaseList ()
 
virtual void Remove ()
 
Bool SetDescIDState (const DescID &id, DESCIDSTATE descidstate)
 
DESCIDSTATE GetDescIDState (const DescID &id, Bool tolerant) const
 
RootPluginNodeGetOverrideRoot ()
 
BaseOverrideGetFirstOverride ()
 
virtual Bool TranslateDescID (const DescID &id, DescID &res_id, GeListNode *&res_at)
 
- Public Member Functions inherited from GeListNode
 GeListNode ()
 
 ~GeListNode ()
 
virtual Bool GetNBit (Int32 bit) const
 
virtual Bool ChangeNBit (NBIT bit, NBITCONTROL bitmode)
 
BaseDocumentGetDocument ()
 
GeListNodeGetPred ()
 
GeListNodeGetNext ()
 
GeListNodeGetUp ()
 
GeListNodeGetDown ()
 
GeListNodeGetDownLast ()
 
void InsertBefore (GeListNode *op)
 
void InsertAfter (GeListNode *op)
 
void Remove ()
 
void InsertUnder (GeListNode *op)
 
void InsertUnderLast (GeListNode *op)
 
RootList2DGetListHead ()
 
Int32 GetNodeID (Int32 index=0) const
 
- Public Member Functions inherited from PrivateChunk
 PrivateChunk ()
 
Bool ReadChunk (HyperFile *hf, Bool keepin=false, Bool noheader=false)
 
virtual Bool IsListHead ()
 
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)
 
virtual Int32 GetChunkLevel ()
 
- Public Member Functions inherited from GeTempPublicNode2D< PrivateChunk >
PrivateChunkGetNext () const
 
PrivateChunkGetPrev () const
 
void InsertBefore (PrivateChunk *n)
 
void InsertAfter (PrivateChunk *n)
 
void Remove ()
 

Private Attributes

Bool locked
 
SmallUVWStructs_data
 
Int32 s_count
 

Constructor/Destructor

 UVWTag ()
 
virtual ~UVWTag ()
 

Data

Int32 GetDataCount ()
 
Bool Resize (Int32 newcnt)
 
ConstUVWHandle GetDataAddressR ()
 
UVWHandle GetDataAddressW ()
 
static void Get (ConstUVWHandle dataPtr, Int32 i, UVWStruct &res)
 
static void Set (UVWHandle dataPtr, Int32 i, const UVWStruct &s)
 
static void Copy (UVWHandle destPtr, Int32 dstIndex, ConstUVWHandle srcPtr, Int32 srcIndex)
 

Get/Set Parameter

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

Private

virtual Bool CopyToX (PrivateChunk *dst, COPYFLAGS flags, AliasTrans *trn)
 
virtual Bool HandleSubChunk (HyperFile *hf, Int32 id, Int32 level)
 
virtual Bool Write (HyperFile *hf)
 
virtual Int32 GetInfo ()
 

Additional Inherited Members

- Static Public Member Functions inherited from BaseTag
static BaseTagAlloc (Int32 type)
 
static void Free (BaseTag *&bl)
 
- Protected Member Functions inherited from BaseTag
virtual Int32 GetInstanceType () const
 
- Protected Member Functions inherited from BaseList2D
void SetID (Int32 id)
 
- Protected Attributes inherited from BaseTag
BaseObjectparent_op
 
- Protected Attributes inherited from BaseList2D
Int32 m_id
 
RootShader mp_rootshader
 
RootShader mp_rootshader_hidden
 
RootShader root_shader_repository
 
Int32 l_bitfeld
 
RootCTrack mp_rootctrack
 
RootPluginNode root_override
 
NotifyListnotify_events
 
DescIdStorekeyframestore
 
DescIdStorepropstore
 
BaseContainer m_bc
 
NodeDatam_data
 
- Protected Attributes inherited from GeListNode
GeAliasGoal m_xgoal
 
UInt32 m_bits [4]
 
RootList2Dt_rootlist_parent
 
RootList2Dm_children
 
BaseDocumentparent_doc
 
void * unknownData
 
Int unknownDataSize
 
Int32 unknownDataLevel
 
Int32 pluginID
 

Detailed Description

UVW tag. Holds UVW data.

Member Typedef Documentation

◆ SUPER

typedef BaseTag SUPER

Constructor & Destructor Documentation

◆ UVWTag()

UVWTag ( )

Default constructor.

◆ ~UVWTag()

virtual ~UVWTag ( )
virtual

Default constructor.

Member Function Documentation

◆ IsInstanceOf()

virtual Bool IsInstanceOf ( cineware::Int32  id) const
virtual

Reimplemented from BaseTag.

◆ GetDataCount()

Int32 GetDataCount ( )

Gets the size of the UVW data array.

Returns
The size of the uvw array.

◆ Resize()

Bool Resize ( Int32  newcnt)

Resizes the UVW data array.

Parameters
[in]newcntThe new UVW data size.
Returns
true if the UVW array was resized successfully, otherwise false.

◆ GetDataAddressR()

ConstUVWHandle GetDataAddressR ( )

Gets a handle to the read-only UVW data.

Returns
The handle to the read-only UVW data. The tag owns the pointed UVW data.

◆ GetDataAddressW()

UVWHandle GetDataAddressW ( )

Gets a handle to the writable UVW data.

Returns
The handle to the writable UVW data. The tag owns the pointed UVW data.

◆ Get()

static void Get ( ConstUVWHandle  dataPtr,
Int32  i,
UVWStruct res 
)
static

Gets the UVW coordinates for a polygon. Example:

ConstUVWHandle dataptr = uvwtag->GetDataAddressR();
for (Int32 i=0; i<cnt; i++)
{
UVWStruct res;
UVWTag::Get(dataptr, i, res);
}
Parameters
[in]dataPtrThe handle to the UVW data. The caller owns the pointed UVW data.
[in]iThe index of the polygon to get the coordinates for.
[out]resAssigned the UVW coordinates for the polygon.

◆ Set()

static void Set ( UVWHandle  dataPtr,
Int32  i,
const UVWStruct s 
)
static

Sets the UVW coordinates for a polygon.

Parameters
[in]dataPtrThe handle to the UVW data. The caller owns the pointed UVW data.
[in]iThe index of the polygon to set the coordinates for.
[out]sThe UVW coordinates for the polygon.

◆ Copy()

static void Copy ( UVWHandle  destPtr,
Int32  dstIndex,
ConstUVWHandle  srcPtr,
Int32  srcIndex 
)
static

Copies UVW coordinates.

Parameters
[in]destPtrThe handle to the destination UVW data.
[in]dstIndexThe destination polygon index in the destination UVW data destptr.
[in]srcPtrThe handle to the source UVW data.
[in]srcIndexThe source polygon index in the source UVW data srcptr.

◆ GetDParameter()

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

Gets a parameter of the tag.

Parameters
[in]idThe ID of the parameter.
[in]dataAssigned the parameter data.
Returns
true if the parameter was retrieved, otherwise false.

Reimplemented from BaseTag.

◆ SetDParameter()

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

Sets a parameter of the tag.

Parameters
[in]idThe ID of the parameter.
[in]dataThe parameter data to set.
Returns
true if the parameter was set, otherwise false.

Reimplemented from BaseTag.

◆ CopyToX()

virtual Bool CopyToX ( PrivateChunk dst,
COPYFLAGS  flags,
AliasTrans trn 
)
virtual

Private.

Reimplemented from BaseTag.

◆ HandleSubChunk()

virtual Bool HandleSubChunk ( HyperFile hf,
Int32  id,
Int32  level 
)
virtual

Private.

Reimplemented from BaseTag.

◆ Write()

virtual Bool Write ( HyperFile hf)
virtual

Private.

Reimplemented from BaseTag.

◆ GetInfo()

virtual Int32 GetInfo ( )
virtual

Private.

Reimplemented from GeListNode.

Member Data Documentation

◆ locked

Bool locked
private

◆ s_data

SmallUVWStruct* s_data
private

◆ s_count

Int32 s_count
private
cineware::UVWTag::Get
static void Get(ConstUVWHandle dataPtr, Int32 i, UVWStruct &res)
cineware::ConstUVWHandle
const typedef void * ConstUVWHandle
Const handle/pointer to UVW data for UVWTag.
Definition: c4d_uvwstruct.h:20
cineware::Int32
int32_t Int32
32 bit signed integer datatype.
Definition: c4d_system.h:186