SplineObject Class Reference

#include <c4d_baseobject.h>

Inheritance diagram for SplineObject:

Detailed Description

Represents a spline object.

Private Member Functions

 SplineObject ()
 
 ~SplineObject ()
 

Alloc/Free

static SplineObjectAlloc (Int32 pcnt, SPLINETYPE type)
 
static void Free (SplineObject *&bl)
 

Spline Point/Tangent

Vector GetSplinePoint (Float t, Int32 segment=0, const Vector *padr=nullptr) const
 
Vector GetSplineTangent (Float t, Int32 segment=0, const Vector *padr=nullptr) const
 

Segment

const SegmentGetSegmentR () const
 
SegmentGetSegmentW ()
 
Int32 GetSegmentCount () const
 

Tangent

const TangentGetTangentR () const
 
TangentGetTangentW ()
 
Int32 GetTangentCount ()
 

Miscellaneous

SPLINETYPE GetInterpolationType () const
 
LineObjectGetLineObject (const BaseDocument *doc, Float lod, BaseThread *thread=nullptr) const
 
Bool IsClosed () const
 
Bool ResizeObject (Int32 pcnt, Int32 scnt)
 
Bool SetDefaultCoeff ()
 

Additional Inherited Members

- Public Member Functions inherited from PointObject
BaseSelectGetWritablePointS ()
 
const BaseSelectGetPointS () const
 
BaseSelectGetWritablePointH ()
 
const BaseSelectGetPointH () const
 
const VectorGetPointR () const
 
VectorGetPointW ()
 
Int32 GetPointCount () const
 
Float32CalcVertexMap (const BaseObject *modifier) const
 
Bool ResizeObject (Int32 pcnt)
 
void IncreaseBoundingBox (Int32 cnt, Vector *v)
 
- Public Member Functions inherited from BaseObject
const MatrixGetDeformMatrix () const
 
void SetDeformMatrix (const Matrix &dm)
 
void ClearDeformMatrix ()
 
const MatrixGetUndeformedMl () const
 
const MatrixGetUndeformedMlInverse () const
 
Matrix GetUndeformedMg () const
 
BaseObjectGetNext ()
 
const BaseObjectGetNext () const
 
BaseObjectGetPred ()
 
const BaseObjectGetPred () const
 
BaseObjectGetUp ()
 
const BaseObjectGetUp () const
 
BaseObjectGetDown ()
 
const BaseObjectGetDown () const
 
BaseObjectGetDownLast ()
 
const BaseObjectGetDownLast () const
 
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 MatrixGetMl () 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) const
 
Vector GetMp () const
 
Vector GetRad () const
 
void GetDimension (Vector &mp, Vector &rad) const
 
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 () const
 
void SetUniqueIP (Int32 ip)
 
BaseTagGetFirstTag ()
 
const BaseTagGetFirstTag () const
 
BaseTagGetLastTag ()
 
const BaseTagGetLastTag () const
 
BaseTagGetTag (Int32 type, Int32 nr=0)
 
const BaseTagGetTag (Int32 type, Int32 nr=0) const
 
maxon::Block< const BaseTag *const > GetTagsOfType (Int32 type) const
 
maxon::Block< BaseTag *const > GetTagsOfType (Int32 type)
 
const void * GetTagDataR (Int32 type, Int32 nr=0) const
 
void * GetTagDataW (Int32 type, Int32 nr=0)
 
Int32 GetTagDataCount (Int32 type) const
 
BaseTagMakeTag (Int32 type, BaseTag *pred=nullptr)
 
VariableTagMakeVariableTag (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) const
 
BaseObjectGetCache ()
 
const BaseObjectGetCache () const
 
BaseObjectGetDeformCache ()
 
const BaseObjectGetDeformCache () const
 
LineObjectGetIsoparm ()
 
void SetIsoparm (LineObject *l)
 
BaseObjectGetCacheParent () const
 
BaseObjectGetCacheTopParent () const
 
Bool SetPhong (Bool on, Bool anglelimit, Float angle)
 
Bool IsDirty (DIRTYFLAGS flags) const
 
void SetDirty (DIRTYFLAGS flags)
 
Bool CheckCache (const HierarchyHelp *hh) const
 
void Touch ()
 
void GetColorProperties (ObjectColorProperties *prop) const
 
void SetColorProperties (ObjectColorProperties *prop)
 
maxon::Opt< maxon::ColorGetDisplayColor () const
 
const MatrixGetModelingAxis (BaseDocument *doc)
 
void SetModelingAxis (const Matrix &m)
 
BaseObjectGetAndCheckHierarchyClone (const HierarchyHelp *hh, BaseObject *op, HIERARCHYCLONEFLAGS flags, Bool *dirty, AliasTrans *trans, Int childCount, maxon::BaseArray< BaseObject * > *children, Bool addChildOrClone=false)
 
BaseObjectGetAndCheckHierarchyClone (const HierarchyHelp *hh, BaseObject *op, HIERARCHYCLONEFLAGS flags, Bool *dirty, AliasTrans *trans, Bool allchildren)
 
BaseObjectGetHierarchyClone (const HierarchyHelp *hh, BaseObject *op, HIERARCHYCLONEFLAGS flags, Bool *dirty, AliasTrans *trans)
 
BaseObjectGetHierarchyClone (const HierarchyHelp *hh, BaseObject *op, HIERARCHYCLONEFLAGS flags, Bool *dirty, AliasTrans *trans, DIRTYFLAGS dirtyflags)
 
void NewDependenceList ()
 
Bool CompareDependenceList ()
 
void AddDependence (const BaseObject *op)
 
void AddDependence (const 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)
 
SplineObjectGetRealSpline ()
 
const SplineObjectGetRealSpline () const
 
Float GetVisibility (Float parent) const
 
Bool SearchHierarchy (const BaseObject *op) const
 
BaseObjectGetOrigin (Bool safe)
 
const BaseObjectGetOrigin (Bool safe) const
 
void SetOrigin (BaseObject *origin)
 
BaseObjectGetTopOrigin (Bool parent, Bool safe) const
 
BaseObjectGetEditObject (BaseObject **psds, DISPLAYEDITSTATE state, Bool safetey=true) const
 
void RemoveFromCache (Bool clearParentObject=true)
 
DRAWRESULT ObjDraw (DRAWPASS drawpass, BaseDraw *bd, BaseDrawHelp *bh)
 
maxon::Tuple< Bool, maxon::HashIntGetObjectDrawHash (Int32 type) const
 
void GetDrawStateData (void *state) const
 
- 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 CharGetViewportRenderId (VIEWPORT_RENDER_ID typeId) const
 
BaseList2DGetNext ()
 
const BaseList2DGetNext () const
 
BaseList2DGetPred ()
 
const BaseList2DGetPred () const
 
BaseContainer GetData ()
 
void SetData (const BaseContainer &bc, Bool add=true)
 
const BaseContainerGetDataInstanceRef () const
 
BaseContainerGetDataInstanceRef ()
 
const BaseContainerGetDataInstance () const
 
BaseContainerGetDataInstance ()
 
String GetName () const
 
void SetName (const maxon::String &name, Bool setDirty=true)
 
String GetBubbleHelp ()
 
Bool TransferGoal (BaseList2D *dst, Bool undolink)
 
Bool TransferMarker (BaseList2D *dst) const
 
Bool CopyDynamicDescriptionFrom (const BaseList2D *src)
 
Bool Scale (Float scale)
 
Bool Edit ()
 
void GetIcon (IconData *dat)
 
GeListHeadGetNLARoot (Bool create)
 
BaseList2DAnimationLayerRemap (BaseObject **layer=nullptr)
 
String GetTypeName () const
 
BaseList2DGetMain () const
 
void InsertTrackSorted (CTrack *track)
 
Bool AddEventNotification (BaseList2D *bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer *data)
 
Bool RemoveEventNotification (const BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
 
Bool FindEventNotification (const BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
 
Bool SetDescIDState (const DescID &id, DESCIDSTATE descidstate)
 
DESCIDSTATE GetDescIDState (const DescID &id, Bool tolerant) const
 
GeListHeadGetOverrideRoot (Bool create)
 
BaseOverrideGetFirstOverride ()
 
GeListHeadGetShaderRepositoryRoot (Bool create)
 
GeListHeadGetHiddenShaderRoot (Bool create)
 
maxon::NimbusForwardRef GetNimbusRef (const maxon::Id &spaceId) const
 
maxon::Result< maxon::NimbusForwardRefPrivateGetOrCreateNimbusRef (const maxon::Id &spaceId)
 
void RemoveNimbusRef (const maxon::Id &spaceId)
 
maxon::Result< maxon::HashMap< maxon::Id, maxon::NimbusForwardRef > > GetAllNimbusRefs () const
 
Bool IsNodeBased () const
 
maxon::Result< BoolGetAccessedObjects (METHOD_ID method, AccessedObjectsCallback &access) const
 
maxon::Result< BoolGetAccessedObjectsRec (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, Bool withSiblings, Bool withChildren, AccessedObjectsCallback &access) const
 
maxon::Result< BoolGetAccessedObjectsOfHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const
 
maxon::Result< BoolGetAccessedObjectsOfChildren (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const
 
maxon::Result< BoolGetAccessedObjectsOfFirstChildHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const
 
maxon::Result< maxon::GenericDataGroupChanges ()
 
void GetMarkerStampEx (UInt32 *l1, UInt32 *l2)
 
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
 
Bool SetAnimatedParameter (const 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) const
 
BaseShaderGetFirstShader () const
 
void InsertShader (BaseShader *shader, BaseShader *pred=nullptr)
 
void ClearKeyframeSelection ()
 
Bool FindKeyframeSelection (const DescID &id)
 
Bool SetKeyframeSelection (const DescID &id, Bool selection)
 
Bool KeyframeSelectionContent ()
 
LayerObjectGetLayerObject (const BaseDocument *doc)
 
const LayerObjectGetLayerObject (const BaseDocument *doc) const
 
Bool SetLayerObject (const LayerObject *layer)
 
const LayerDataGetLayerData (const BaseDocument *doc, Bool rawdata=false) const
 
Bool SetLayerData (BaseDocument *doc, const LayerData &data)
 
GeListHeadGetCTrackRoot (Bool create)
 
const GeListHeadGetCTrackRoot () const
 
CTrackGetFirstCTrack ()
 
const CTrackGetFirstCTrack () const
 
CTrackFindCTrack (const DescID &id)
 
const CTrackFindCTrack (const DescID &id) const
 
- Public Member Functions inherited from GeListNode
GeListNodeGetNext ()
 
const GeListNodeGetNext () const
 
GeListNodeGetPred ()
 
const GeListNodeGetPred () const
 
GeListNodeGetDown ()
 
const GeListNodeGetDown () const
 
GeListNodeGetUp ()
 
const GeListNodeGetUp () const
 
GeListNodeGetDownLast ()
 
const GeListNodeGetDownLast () const
 
void InsertBefore (GeListNode *bl)
 
void InsertAfter (GeListNode *bl)
 
void InsertUnder (GeListNode *bl)
 
void InsertUnderLast (GeListNode *bl)
 
void Remove ()
 
void FlushChilds ()
 
void MoveChildrenTo (GeListNode *dest)
 
GeListHeadGetListHead ()
 
const GeListHeadGetListHead () const
 
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)
 
GeListNodeGetCustomData ()
 
const GeListNodeGetCustomData () const
 
const BaseDocumentGetDocument () const
 
BaseDocumentGetDocument ()
 
maxon::Result< BoolGetBranchInfo (const maxon::ValueReceiver< const BranchInfo & > &info, GETBRANCHINFO flags) const
 
Bool IsDocumentRelated () const
 
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)
 
C4DAtomGetClone (COPYFLAGS flags, AliasTrans *trn) const
 
Bool CopyTo (C4DAtom *dst, COPYFLAGS flags, AliasTrans *trn) const
 
Bool Read (HyperFile *hf, Int32 id, Int32 level)
 
Bool Write (HyperFile *hf) const
 
Bool ReadObject (HyperFile *hf, Bool readheader)
 
Bool WriteObject (HyperFile *hf) const
 
Bool GetDescription (Description *description, DESCFLAGS_DESC flags) const
 
Bool GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags) const
 
Bool SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)
 
DynamicDescriptionGetDynamicDescriptionWritable ()
 
const DynamicDescriptionGetDynamicDescription () const
 
Bool CopyDynamicDescriptionFrom (const BaseList2D *src)
 
Bool GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc) const
 
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 inherited from BaseObject
static BaseObjectAlloc (Int32 type)
 
static void Free (BaseObject *&bl)
 
- Static Public Member Functions inherited from BaseList2D
static BaseList2DAlloc (Int32 type)
 
static void Free (BaseList2D *&bl)
 
- Static Public Attributes inherited from BaseList2D
static const Int32 SETBIT_FLAG_NODIRTY
 
static const Int32 SETBIT_FLAG_REMOVE
 

Constructor & Destructor Documentation

◆ SplineObject()

SplineObject ( )
private

◆ ~SplineObject()

~SplineObject ( )
private

Member Function Documentation

◆ Alloc()

static SplineObject* Alloc ( Int32  pcnt,
SPLINETYPE  type 
)
static

Allocates a Spline object. Destroy the allocated Spline object with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters
[in]pcntThe point count.
[in]typeThe spline type: SPLINETYPE
Returns
The allocated Spline object, or nullptr if the allocation failed.

◆ Free()

static void Free ( SplineObject *&  bl)
static

Destructs Spline objects allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters
[in,out]blThe Spline object to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆ GetSplinePoint()

Vector GetSplinePoint ( Float  t,
Int32  segment = 0,
const Vector padr = nullptr 
) const

Gets the spline point at a position along the given segment.

Parameters
[in]tThe position 0.0 <= t <= 1.0 along the segment.
The positioning is natural, for example t = 0.5 is not necessarily at half the length. Use SplineLengthData::UniformToNatural() to get a uniform distribution.
[in]segmentThe segment to get the point in.
[in]padrFor speedup purposes pass a pointer to the start of the specified segment in the point array. Otherwise the spline has to search its array manually.
Returns
The spline point.

◆ GetSplineTangent()

Vector GetSplineTangent ( Float  t,
Int32  segment = 0,
const Vector padr = nullptr 
) const

Gets the tangent of a spline at a position along the given segment.

Parameters
[in]tThe position 0.0 <= t <= 1.0 along the segment.
The positioning is natural, for example t = 0.5 is not necessarily at half the length. Use SplineLengthData::UniformToNatural() to get a uniform distribution.
[in]segmentThe segment to get the point in.
[in]padrFor speedup purposes pass a pointer to the start of the specified segment in the point array. Otherwise the spline has to search its array manually.
Returns
The spline tangent.

◆ GetSegmentR()

const Segment* GetSegmentR ( ) const

Gets the first element in the read-only segments array.

Returns
The read-only segment array address. The Spline object owns the pointed array.

◆ GetSegmentW()

Segment* GetSegmentW ( )

Gets the first element in the writable segments array.

Returns
The writable segment array address. The Spline object owns the pointed array.

◆ GetSegmentCount()

Int32 GetSegmentCount ( ) const

Gets the number of segments.

Returns
The segment count.

◆ GetTangentR()

const Tangent* GetTangentR ( ) const

Gets the first element in the read-only tangents array.

Returns
The read-only tangent array address. The Spline object owns the pointed array.

◆ GetTangentW()

Tangent* GetTangentW ( )

Gets the first element in the writable tangents array.

Returns
The writable tangent array address. The Spline object owns the pointed array.

◆ GetTangentCount()

Int32 GetTangentCount ( )

Gets the number of tangents.

Returns
The tangent count.

◆ GetInterpolationType()

SPLINETYPE GetInterpolationType ( ) const

Gets the interpolation type of the spline.

Returns
The interpolation type: SPLINETYPE

◆ GetLineObject()

LineObject* GetLineObject ( const BaseDocument doc,
Float  lod,
BaseThread thread = nullptr 
) const

Gets a line based object from the spline.

Parameters
[in]docThe document containing the spline object. The caller owns the pointed document.
[in]lodThe level of detail to create the line.
[in]threadA thread to check for a break or nullptr. The caller owns the pointed thread.
Returns
A line based representation of the spline. The caller owns the pointed Line object.

◆ IsClosed()

Bool IsClosed ( ) const

Checks if the spline is closed.

Returns
true if the spline is closed., otherwise false.

◆ ResizeObject()

Bool ResizeObject ( Int32  pcnt,
Int32  scnt 
)

Changes the number of segments and points for the spline.

Parameters
[in]pcntThe new point count.
[in]scntThe new segment count.
Returns
true if the number of points and segments was changed successfully, otherwise false.

◆ SetDefaultCoeff()

Bool SetDefaultCoeff ( )

Initializes the spline with default coefficients.

Returns
true if successful, otherwise false.