#include <lib_sds.h>

Inheritance diagram for SDSObject:

[legend]

Detailed Description

The SDS object class of type Osds.

Note: Has to be created with Alloc() and destroyed with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Public Member Functions
Int32	GetDivision (BaseObject *op)

PolygonObject *	GetSDSMesh (BaseObject *op)

Bool	TransformPoint (BaseObject op, Int32 ply, Float &s, Float &t, Vector p)

Bool	GetNormal (BaseObject op, Int32 ply, Vector p, Vector *n)

SDSSubdivisionMask *	GetSubdivisionMask (BaseObject op, Int32 &maskcnt, Int32 &polymap, Bool &ngonsubdiv)

void *	GetCreationData (BaseObject *op)

Public Member Functions inherited from BaseObject
BaseObject *	GetNext ()

BaseObject *	GetPred ()

BaseObject *	GetUp ()

BaseObject *	GetDown ()

BaseObject *	GetDownLast ()

Vector	GetAbsPos () const

void	SetAbsPos (const Vector &v)

Vector	GetAbsScale () const

void	SetAbsScale (const Vector &v)

Vector	GetAbsRot () const

void	SetAbsRot (const Vector &v)

Vector	GetFrozenPos () const

void	SetFrozenPos (const Vector &v)

Vector	GetFrozenScale () const

void	SetFrozenScale (const Vector &v)

Vector	GetFrozenRot () const

void	SetFrozenRot (const Vector &v)

Vector	GetRelPos () const

void	SetRelPos (const Vector &v)

Vector	GetRelScale () const

void	SetRelScale (const Vector &v)

Vector	GetRelRot () const

void	SetRelRot (const Vector &v)

const Matrix &	GetMl () const

void	SetMl (const Matrix &m)

Matrix	GetFrozenMln () const

Matrix	GetRelMln () const

Matrix	GetRelMl () const

void	SetRelMl (const Matrix &m)

Matrix	GetMg () const

void	SetMg (const Matrix &m)

Matrix	GetMln () const

Matrix	GetMgn () const

Matrix	GetUpMg () const

void	CopyMatrixTo (BaseObject *dst)

Vector	GetMp ()

Vector	GetRad ()

void	GetDimension (Vector &mp, Vector &rad)

Int32	GetEditorMode () const

Int32	GetEditorModeH () const

void	SetEditorMode (Int32 mode)

Int32	GetRenderMode () const

Int32	GetRenderModeH () const

void	SetRenderMode (Int32 mode)

Bool	GetDeformMode () const

void	SetDeformMode (Bool mode)

Int32	GetRealDeformMode () const

void	SetRealDeformMode (Int32 mode)

Int32	GetUniqueIP ()

void	SetUniqueIP (Int32 ip)

BaseTag *	GetFirstTag ()

BaseTag *	GetLastTag ()

BaseTag *	GetTag (Int32 type, Int32 nr=0)

const maxon::BaseArray< BaseTag * > *	GetTagsOfType (Int32 type) const

const maxon::BaseArray< BaseTag * > *	GetTagsWithFlags (Int32 flags) const

const void *	GetTagDataR (Int32 type, Int32 nr=0) const

void *	GetTagDataW (Int32 type, Int32 nr=0)

Int32	GetTagDataCount (Int32 type) const

BaseTag *	MakeTag (Int32 type, BaseTag *pred=nullptr)

VariableTag *	MakeVariableTag (Int32 type, Int32 count, BaseTag *pred=nullptr)

void	InsertTag (BaseTag tp, BaseTag pred=nullptr)

void	KillTag (Int32 type, Int32 nr=0)

Bool	CopyTagsTo (BaseObject dest, Int32 visible, Int32 variable, Int32 hierarchical, AliasTrans trans)

BaseObject *	GetCache (HierarchyHelp *hh=nullptr)

BaseObject *	GetDeformCache ()

LineObject *	GetIsoparm ()

void	SetIsoparm (LineObject *l)

BaseObject *	GetCacheParent () const

BaseObject *	GetCacheTopParent () const

Bool	SetPhong (Bool on, Bool anglelimit, Float angle)

Bool	IsDirty (DIRTYFLAGS flags)

void	SetDirty (DIRTYFLAGS flags)

Bool	CheckCache (HierarchyHelp *hh)

void	Touch ()

void	GetColorProperties (ObjectColorProperties *prop)

void	SetColorProperties (ObjectColorProperties *prop)

const Matrix &	GetModelingAxis (BaseDocument *doc)

void	SetModelingAxis (const Matrix &m)

BaseObject *	GetAndCheckHierarchyClone (HierarchyHelp hh, BaseObject op, HIERARCHYCLONEFLAGS flags, Bool dirty, AliasTrans trans, Int childCount, maxon::BaseArray< BaseObject * > *children, Bool addChildOrClone=false)

BaseObject *	GetAndCheckHierarchyClone (HierarchyHelp hh, BaseObject op, HIERARCHYCLONEFLAGS flags, Bool dirty, AliasTrans trans, Bool allchildren)

BaseObject *	GetHierarchyClone (HierarchyHelp hh, BaseObject op, HIERARCHYCLONEFLAGS flags, Bool dirty, AliasTrans trans)

BaseObject *	GetHierarchyClone (HierarchyHelp hh, BaseObject op, HIERARCHYCLONEFLAGS flags, Bool dirty, AliasTrans trans, DIRTYFLAGS dirtyflags)

void	NewDependenceList ()

Bool	CompareDependenceList ()

void	AddDependence (HierarchyHelp hh, BaseObject op)

void	AddDependence (HierarchyHelp hh, BaseObject op, DIRTYFLAGS dirtyflags)

void	TouchDependenceList ()

void	SetRotationOrder (ROTATIONORDER order)

ROTATIONORDER	GetRotationOrder () const

void	SetQuaternionRotationMode (Bool active, Bool bUndo)

Bool	IsQuaternionRotationMode ()

Bool	SynchronizeVectorTrackKeys (Int32 vectorTrackID, Bool bUndo, BaseTime startRange=BaseTime(-108000, 1), BaseTime endRange=BaseTime(108000, 1))

Bool	FindBestEulerAngle (Int32 rotationTrackID, Bool bAdjustTangent, Bool bUndo, BaseTime startRange=BaseTime(-108000, 1), BaseTime endRange=BaseTime(108000, 1))

Bool	EvaluateSynchronizedRotation (const BaseTime &time, ANIMATEFLAGS flags, Vector *resultRotation=nullptr)

Bool	GetVectorTracks (const DescID &id, CTrack &xfound, CTrack &yfound, CTrack *&zfound)

Bool	GetVectorCurves (CCurve curveToSearch, CCurve &xfound, CCurve &yfound, CCurve &zfound)

UInt64	GetGUID ()

Int32	GetHighlightHandle (BaseDraw *bd)

SplineObject *	GetRealSpline ()

Float	GetVisibility (Float parent)

Bool	SearchHierarchy (BaseObject *op)

BaseObject *	GetOrigin (Bool safe)

void	SetOrigin (BaseObject *origin)

BaseObject *	GetTopOrigin (Bool parent, Bool safe)

BaseObject *	GetEditObject (BaseObject **psds, DISPLAYEDITSTATE state, Bool safetey=true)

void	RemoveFromCache ()

DRAWRESULT	ObjDraw (DRAWPASS drawpass, BaseDraw bd, BaseDrawHelp bh)

Public Member Functions inherited from BaseList2D
void	SetBit (Int32 mask)

Bool	GetBit (Int32 mask) const

void	DelBit (Int32 mask)

void	ToggleBit (Int32 mask)

Int32	GetAllBits () const

void	SetAllBits (Int32 bits)

void	SetBitEx (Int32 mask, Int32 flags)

const Char *	GetViewportRenderId (VIEWPORT_RENDER_ID typeId) const

BaseList2D *	GetNext ()

BaseList2D *	GetPred ()

BaseContainer	GetData ()

void	SetData (const BaseContainer &bc, Bool add=true)

const BaseContainer *	GetDataInstance () const

BaseContainer *	GetDataInstance ()

const BaseContainer &	GetDataInstanceRef () const

BaseContainer &	GetDataInstanceRef ()

String	GetName () const

void	SetName (const maxon::String &name)

String	GetBubbleHelp ()

Bool	TransferGoal (BaseList2D *dst, Bool undolink)

Bool	TransferMarker (BaseList2D *dst) const

Bool	Scale (Float scale)

Bool	Edit ()

void	GetIcon (IconData *dat)

GeListHead *	GetNLARoot ()

BaseList2D *	AnimationLayerRemap (BaseObject **layer=nullptr)

String	GetTypeName ()

BaseList2D *	GetMain () const

void	InsertTrackSorted (CTrack *track)

Bool	AddEventNotification (BaseList2D bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer data)

Bool	RemoveEventNotification (BaseDocument doc, BaseList2D bl, NOTIFY_EVENT eventid)

Bool	FindEventNotification (BaseDocument doc, BaseList2D bl, NOTIFY_EVENT eventid)

Bool	SetDescIDState (const DescID &id, DESCIDSTATE descidstate)

DESCIDSTATE	GetDescIDState (const DescID &id, Bool tolerant) const

GeListHead *	GetOverrideRoot ()

BaseOverride *	GetFirstOverride ()

GeListHead *	GetShaderRepositoryRoot ()

GeListHead *	GetHiddenShaderRoot ()

maxon::NimbusForwardRef	GetNimbusRef (const maxon::Id &spaceId) const

maxon::Result< maxon::NimbusForwardRef >	PrivateGetOrCreateNimbusRef (const maxon::Id &spaceId)

void	RemoveNimbusRef (const maxon::Id &spaceId)

maxon::Result< maxon::HashMap< maxon::Id, maxon::NimbusForwardRef > >	GetAllNimbusRefs () const

Bool	IsNodeBased () const

void	GetMarkerStampEx (UInt32 l1, UInt32 l2)

const GeMarker &	GetMarker () 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

Bool	SetAnimatedParameter (CTrack *track, const DescID &id, const GeData &t_data1, const GeData &t_data2, Float mix, DESCFLAGS_SET flags)

Bool	GetAnimatedParameter (const DescID &id, GeData &t_data1, GeData &t_data2, Float &mix, DESCFLAGS_GET flags)

BaseShader *	GetFirstShader () const

void	InsertShader (BaseShader shader, BaseShader pred=nullptr)

void	ClearKeyframeSelection ()

Bool	FindKeyframeSelection (const DescID &id)

Bool	SetKeyframeSelection (const DescID &id, Bool selection)

Bool	KeyframeSelectionContent ()

LayerObject *	GetLayerObject (BaseDocument *doc)

Bool	SetLayerObject (LayerObject *layer)

const LayerData *	GetLayerData (BaseDocument *doc, Bool rawdata=false)

Bool	SetLayerData (BaseDocument *doc, const LayerData &data)

GeListHead *	GetCTrackRoot ()

CTrack *	GetFirstCTrack ()

CTrack *	FindCTrack (const DescID &id)

Public Member Functions inherited from GeListNode
GeListNode *	GetNext ()

GeListNode *	GetPred ()

GeListNode *	GetDown ()

GeListNode *	GetUp ()

GeListNode *	GetDownLast ()

void	InsertBefore (GeListNode *bl)

void	InsertAfter (GeListNode *bl)

void	InsertUnder (GeListNode *bl)

void	InsertUnderLast (GeListNode *bl)

void	Remove ()

GeListHead *	GetListHead ()

Int32	GetNodeID (Int32 index=0) const

template<typename CAST >
const CAST *	GetNodeData (Int32 index=0) const

template<typename CAST >
CAST *	GetNodeData (Int32 index=0)

void	SetCustomData (GeListNode *node)

GeListNode *	GetCustomData ()

BaseDocument *	GetDocument ()

Int32	GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)

Bool	IsDocumentRelated ()

Int32	GetInfo () const

Bool	GetNBit (NBIT bit) const

UInt32	GetNBitMask (Int32 index) const

Bool	ChangeNBit (NBIT bit, NBITCONTROL bitmode)

Public Member Functions inherited from C4DAtom
Int32	GetType () const

Int32	GetRealType () const

Int32	GetDiskType () const

Bool	IsInstanceOf (Int32 id) const

Int32	GetClassification () const

Bool	Message (Int32 type, void *data=nullptr)

Bool	MultiMessage (MULTIMSG_ROUTE flags, Int32 type, void *data)

C4DAtom *	GetClone (COPYFLAGS flags, AliasTrans *trn)

Bool	CopyTo (C4DAtom dst, COPYFLAGS flags, AliasTrans trn)

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

Bool	Write (HyperFile *hf)

Bool	ReadObject (HyperFile *hf, Bool readheader)

Bool	WriteObject (HyperFile *hf)

Bool	GetDescription (Description *description, DESCFLAGS_DESC flags)

Bool	GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags)

Bool	SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)

DynamicDescription *	GetDynamicDescription ()

Bool	GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc)

Bool	TranslateDescID (const DescID &id, DescID &res_id, C4DAtom *&res_at)

UInt32	GetDirty (DIRTYFLAGS flags) const

void	SetDirty (DIRTYFLAGS flags)

UInt32	GetHDirty (HDIRTYFLAGS mask) const

void	SetHDirty (HDIRTYFLAGS mask)

Static Public Member Functions
static Int32	GetPointCount (BaseTag *pTag)

static Float32 *	GetPointWeights (BaseTag *pTag)

static Int32	GetPolygonCount (BaseTag *pTag)

static PolyWeight *	GetEdgeWeights (BaseTag *pTag)

Static Public Member Functions inherited from BaseObject
static BaseObject *	Alloc (Int32 type)

static void	Free (BaseObject *&bl)

Static Public Member Functions inherited from BaseList2D
static BaseList2D *	Alloc (Int32 type)

static void	Free (BaseList2D *&bl)

Private Member Functions
	SDSObject ()

	~SDSObject ()

Additional Inherited Members
Static Public Attributes inherited from BaseList2D
static const Int32	SETBIT_FLAG_NODIRTY

static const Int32	SETBIT_FLAG_REMOVE

Constructor & Destructor Documentation

◆ SDSObject()

SDSObject ( )

private

◆ ~SDSObject()

~SDSObject ( )

private

Member Function Documentation

◆ GetDivision()

Int32 GetDivision ( BaseObject * op )

Gets the subdivision of op.

Parameters

[in] op A child of the SDS object. The caller owns the pointed object.

Returns: The subdivision.

◆ GetSDSMesh()

PolygonObject* GetSDSMesh ( BaseObject * op )

Retrieves the subdivided mesh of op, if it has been generated. (A convenience function to get the cache.)

Parameters

[in] op A child of the SDS object. The caller owns the pointed object.

Returns: The subdivided mesh. Cinema 4D owns the pointed polygon object.

◆ TransformPoint()

Bool TransformPoint	(	BaseObject *	op,
		Int32	ply,
		Float &	s,
		Float &	t,
		Vector *	p
	)

Dummy function. Always return false.

◆ GetNormal()

Bool GetNormal	(	BaseObject *	op,
		Int32	ply,
		Vector *	p,
		Vector *	n
	)

Gets the transformed normal of polygon ply of op.

Parameters

[in]	op	A child of the SDS object. The caller owns the pointed object.
[in]	ply	A polygon index.
[out]	p	Assigned the origin of the normal (center of the polygon).
[out]	n	Assigned the normal.

Returns: true if successful, otherwise false.

◆ GetPointCount()

static Int32 GetPointCount ( BaseTag * pTag )

static

Gets the number of point weighs that are stored in a Tsds tags.

Parameters

[in] pTag A Tsds tag. The caller owns the pointed tag.

Returns: The number of point weights.

◆ GetPointWeights()

static Float32* GetPointWeights ( BaseTag * pTag )

static

Extracts point weights from Tsds tags.

Parameters

[in] pTag A Tsds tag. The caller owns the pointed tag.

Returns: The point weights. The tag owns the pointed array.

◆ GetPolygonCount()

static Int32 GetPolygonCount ( BaseTag * pTag )

static

Gets the number of polygon/edge weighs that are stored in a Tsds tags.

Parameters

[in] pTag A Tsds tag. The caller owns the pointed tag.

Returns: The number of polyon/edge weights.

◆ GetEdgeWeights()

static PolyWeight* GetEdgeWeights ( BaseTag * pTag )

static

Extracts polygon weights from Tsds tags.

Parameters

[in] pTag A Tsds tag. The caller owns the pointed tag.

Returns: The polygon weights. The tag owns the pointed array.

◆ GetSubdivisionMask()

SDSSubdivisionMask* GetSubdivisionMask	(	BaseObject *	op,
		Int32 &	maskcnt,
		Int32 *&	polymap,
		Bool &	ngonsubdiv
	)

Used to determine the original polygons in the subdivided mesh.

Parameters

[in]	op	A child of the SDS object. The caller owns the pointed object.
[out]	maskcnt	Assigned the number of entries in the SDSSubdivisionMask array (should be equal to the polygon count of the subdivided object).
[out]	polymap	Assigned an array of the first new polygon that was made of a polygon during subdivision. The first polygon made of `polyindex` is `polymap[polyindex]`. The SDS object owns the pointed array.
[out]	ngonsubdiv	Assigned true if an N-gon subdivision algorithm was used, otherwise false. It is only false when Catmull-Clark without the N-gons option is used. If an N-gon subdivision algorithm is used, alls polygons that were made out of an N-gon are in a single block in the new object, otherwise they may be spread within the complete object.

Returns: The subdivision mask array. The SDS object owns the pointed array.

◆ GetCreationData()

void* GetCreationData ( BaseObject * op )

Private.

Detailed Description

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ SDSObject()

◆ ~SDSObject()

Member Function Documentation

◆ GetDivision()

◆ GetSDSMesh()

◆ TransformPoint()

◆ GetNormal()

◆ GetPointCount()

◆ GetPointWeights()

◆ GetPolygonCount()

◆ GetEdgeWeights()

◆ GetSubdivisionMask()

◆ GetCreationData()