collapse_all

expand_all

collapse_allexpand_alldropdowndropdownHovercopycodecopycodeHighlight

collapse_all Collapse AllExpand All     dropdown Code: All Code: Multiple Code: C# Code: Visual Basic Code: Visual C++     dropdown Members: Show All Members: Filtered Members: Filtered Members: Filtered

[TCheckBoxFormControlObj]C#

[TCheckBoxFormControlObj]Visual Basic

[TCheckBoxFormControlObj]
Visual C++

[TCheckBoxFormControlObj]Include Protected Members

[TCheckBoxFormControlObj]
Include Inherited Members
DPSF API Documentation
MagnetLine Members

gradient

The MagnetLine type exposes the following members.

collapse_allConstructors

 

Name

Description

pubmethod

MagnetLine(MagnetLine)

Copy Constructor

pubmethod

MagnetLine(Vector3, Vector3, DefaultParticleSystemMagnet..::..MagnetModes, DefaultParticleSystemMagnet..::..DistanceFunctions, Single, Single, Single, Int32)

Explicit Constructor

collapse_allMethods

 

Name

Description

pubmethod

CopyFrom(DefaultParticleSystemMagnet)

Copies the given Magnet's data into this Magnet's data

(Inherited from DefaultParticleSystemMagnet.)

pubmethod

CopyFrom(MagnetLine)

Copies the given Line Magnet's data into this Line Magnet's data

pubmethod

Equals

Determines whether the specified Object is equal to the current Object.

(Inherited from Object.)

protmethod

Finalize

Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

(Inherited from Object.)

pubmethod

GetHashCode

Serves as a hash function for a particular type.

(Inherited from Object.)

pubmethod

GetType

Gets the Type of the current instance.

(Inherited from Object.)

protmethod

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

pubmethod

SetDirection

Sets the Direction of the Line by specifying 2 points in 3D space that are on the Line.

NOTE: The 2 points cannot be the same.

pubmethod

ToString

Returns a String that represents the current Object.

(Inherited from Object.)

collapse_allFields

 

Name

Description

pubfield

DistanceFunction

The Function to use to determine how much a Particle should be affected by the Magnet based on how far away from the Magnet it is.

(Inherited from DefaultParticleSystemMagnet.)

pubfield

MaxDistance

The Max Distance that the Magnet should be able to affect Particles at. If the Particle is further away from the Magnet than this distance, the Magnet will not affect the Particle.

(Inherited from DefaultParticleSystemMagnet.)

pubfield

MaxForce

The Maximum Force that the Magnet is able to exert on a Particle.

The Force exerted on a particle by a Magnet may vary depending on which Distance Function is used, and the particle's distance from the Magnet.

(Inherited from DefaultParticleSystemMagnet.)

protfield

meMagnetType

Holds the Type of Magnet this is

(Inherited from DefaultParticleSystemMagnet.)

pubfield

MinDistance

The Min Distance that the Magnet should be able to affect Particles at. If the Particle is closer to the Magnet than this distance, the Magnet will not affect the Particle.

(Inherited from DefaultParticleSystemMagnet.)

pubfield

Mode

The current Mode that the Magnet is in

(Inherited from DefaultParticleSystemMagnet.)

pubfield

UserDefinedMagnetType

The Type of User-Defined Magnet this is. User-defined Magnet classes will all have a MagnetType = MagnetTypes.UserDefined, so this field can be used to distinguish between different user-defined Magnet classes. This may be used in conjunction with the "Other" Magnet Mode to distinguish which type of custom user effect the Magnet should have on the Particles.

(Inherited from DefaultParticleSystemMagnet.)

collapse_allProperties

 

Name

Description

pubproperty

Direction

The direction that the Line points in. This direction, along with the opposite (i.e. negative) of this direction form the line, since a line has infinite length. This value is automatically normalized when it is set.

pubproperty

ID

Get the unique ID of this Magnet

(Inherited from DefaultParticleSystemMagnet.)

pubproperty

MagnetType

Gets what Type of Magnet this is

(Inherited from DefaultParticleSystemMagnet.)

pubproperty

PositionOnLine

A 3D point that the Line passes through

collapse_allSee Also

MagnetLine Class

DPSF Namespace

footer

Send comments on this topic to
Dan@DansKingdom.com